org.osid.id.batch

Interface IdBatchManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, IdBatchProfile, 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

Method Summary

Methods

Modifier and Type	Method and 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 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.batch.IdBatchProfile

supportsIdBatchAdmin, supportsIdBatchIssue

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

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 supportsIdBatchIssue() is 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 supportsIdBatchAdmin() is true.