org.osid.id.batch

Interface IdBatchProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, IdBatchProfile, OsidProfile, OsidProxyManager, Sourceable

public interface IdBatchProxyManager
extends OsidProxyManager, IdBatchProfile

The Id batch manager provides access to Id batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object for the purpose of pasisng information from a server envrionment. 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(Proxy proxy) Gets the session associated with the Id bulk administrative service.
IdBatchIssueSession	getIdBatchIssueSession(Proxy proxy) Gets the session associated with the Id bulk issue service.

Methods inherited from interface org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

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

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(Proxy proxy)
                                           throws OperationFailedException

Gets the session associated with the Id bulk issue service.

Parameters:

proxy - a proxy

Returns:

an IdBatchIssueSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIdBatchIssue() is false

Compliance:

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

getIdBatchAdminSession

IdBatchAdminSession getIdBatchAdminSession(Proxy proxy)
                                           throws OperationFailedException

Gets the session associated with the Id bulk administrative service.

Parameters:

proxy - a proxy

Returns:

an IdBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIdBatchAdmin() is false

Compliance:

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