Interface IdBatchManager

All Superinterfaces:

AutoCloseable, Closeable, IdBatchProfile, OsidManager, OsidManager, OsidProfile, Sourceable

public interface IdBatchManager
extends OsidManager, IdBatchProfile

The Id batch manager provides access to Id batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• IdBatchIssueSession: a session to issue Ids in bulk
• IsBatchAdminSession: a session to create, modify and delete Ids in bulk

IdBatchManager may be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
IdBatchAdminSession	getIdBatchAdminSession()	Gets the session associated with the Id bulk admin service.
IdBatchIssueSession	getIdBatchIssueSession()	Gets the session associated with the Id bulk issue service.

Methods inherited from interface Closeable

close

Methods inherited from interface IdBatchProfile

supportsIdBatchAdmin, supportsIdBatchIssue

Methods inherited from interface OsidManager

close

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface OsidProfile

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

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Details

getIdBatchIssueSession

IdBatchIssueSession getIdBatchIssueSession()
                                    throws OperationFailedException

Gets the session associated with the Id bulk issue service.

Returns:

an IdBatchIssueSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdBatchIssue() is false

Compliance:

optional - This method must be implemented if {@code supportsIdBatchIssue()} is {@code true}.

getIdBatchAdminSession

IdBatchAdminSession getIdBatchAdminSession()
                                    throws OperationFailedException

Gets the session associated with the Id bulk admin service.

Returns:

an IdBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdBatchAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsIdBatchAdmin()} is {@code true}.