Interface IdBatchProxyManager

All Superinterfaces:

AutoCloseable, Closeable, IdBatchProfile, OsidProfile, OsidProxyManager, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface IdBatchProfile

supportsIdBatchAdmin, supportsIdBatchIssue

Modifier and Type	Method	Description
boolean	supportsIdBatchAdmin()	Tests if an Id bulk administrative service is supported.
boolean	supportsIdBatchIssue()	Tests if an Id bulk issue service is supported.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids .
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

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 {@code supportsIdIssue()} is {@code 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 {@code supportsIdBatchAdmin()} is {@code true} .