org.osid.id

Interface IdManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, IdProfile, OsidManager, OsidProfile, Sourceable

public interface IdManager
extends OsidManager, IdProfile

This manager provides access to the available sessions of the Id service. Ids are created through the IdAdminSession which provides the means for creating a unique identifier.

The IdLookupSession can be used for mapping one Id to another in addition to getting a list of the assigned identifiers.

Method Summary

Methods

Modifier and Type	Method and Description
IdAdminSession	getIdAdminSession() Gets the session associated with the id admin service.
IdBatchManager	getIdBatchManager() Gets an IdBatchManager.
IdIssueSession	getIdIssueSession() Gets the session associated with the id issue service.
IdLookupSession	getIdLookupSession() Gets the session associated with the id lookup service.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.id.IdProfile

supportsIdAdmin, supportsIdBatch, supportsIdIssue, supportsIdLookup

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getIdLookupSession

IdLookupSession getIdLookupSession()
                                   throws OperationFailedException

Gets the session associated with the id lookup service.

Returns:

an IdLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdLookup() is false

Compliance:

optional - This method must be implemented if supportsIdLookup() is true.

getIdIssueSession

IdIssueSession getIdIssueSession()
                                 throws OperationFailedException

Gets the session associated with the id issue service.

Returns:

an IdIssueSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdIssue() is false

Compliance:

optional - This method must be implemented if supportsIdIssue() is true.

getIdAdminSession

IdAdminSession getIdAdminSession()
                                 throws OperationFailedException

Gets the session associated with the id admin service.

Returns:

an IdAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdAdmin() is false

Compliance:

optional - This method must be implemented if supportsIdAdmin() is true.

getIdBatchManager

IdBatchManager getIdBatchManager()
                                 throws OperationFailedException

Gets an IdBatchManager.

Returns:

an IdBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdBatch() is false

Compliance:

optional - This method must be implemented if supportsIdBatch() is true.