org.osid.id

Interface IdIssueSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

IdBatchIssueSession

public interface IdIssueSession
extends OsidSession

This is a simple session used to create new Ids.

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.