Interface IdIssueSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

IdBatchIssueSession

public interface IdIssueSession
extends OsidSession

This is a simple session used to create new Ids .

Method Summary

Modifier and Type	Method	Description
boolean	canIssueIds()	Tests if this user can issue Ids .
Id	issueId()	Issues a new Id .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canIssueIds

boolean canIssueIds()

Tests if this user can issue Ids . A return of true does not guarantee successful authorization. A return of false indicates that it is known create methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer create operations.

Returns:

false if create methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

issueId

Id issueId()
    throws OperationFailedException,
PermissionDeniedException

Issues a new Id . This method creates a new Id for a predetermined authority and namespace.

Returns:

the new Id

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.