Interface IdProxyManager

All Superinterfaces:

AutoCloseable, Closeable, IdProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface IdProxyManager
extends OsidProxyManager, IdProfile

This manager provides access to the available sessions of the Id service. Methods in this manager support the passing of a Proxy object for the purpose of pasisng information from a server envrionment.

Ids are created through the IdAdminSession which provides the means for creating a unique identifier. The IdBrowserSession can be used for mapping one Id to another in addition to getting a list of the assigned identifiers.

Method Summary

Modifier and Type	Method	Description
IdAdminSession	getIdAdminSession(Proxy proxy)	Gets the session associated with the id administrative service.
IdBatchProxyManager	getIdBatchProxyManager()	Gets an IdnProxyManager .
IdIssueSession	getIdIssueSession(Proxy proxy)	Gets the session associated with the id issue service.
IdLookupSession	getIdLookupSession(Proxy proxy)	Gets the session associated with the id lookup service.

Methods inherited from interface Closeable

close

Methods inherited from interface IdProfile

supportsIdAdmin, supportsIdBatch, supportsIdIssue, supportsIdLookup

Modifier and Type	Method	Description
boolean	supportsIdAdmin()	Tests if an Id administrative service is supported.
boolean	supportsIdBatch()	Tests for the availability of an Id batch service.
boolean	supportsIdIssue()	Tests if an Id issue service is supported.
boolean	supportsIdLookup()	Tests if Id lookup 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

getIdLookupSession

IdLookupSession getIdLookupSession(Proxy proxy)
                            throws OperationFailedException

Gets the session associated with the id lookup service.

Parameters:

proxy - a proxy

Returns:

an IdLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIdLookup() is false

Compliance:

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

getIdIssueSession

IdIssueSession getIdIssueSession(Proxy proxy)
                          throws OperationFailedException

Gets the session associated with the id issue service.

Parameters:

proxy - a proxy

Returns:

an IdIssueSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIdIssue() is false

Compliance:

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

getIdAdminSession

IdAdminSession getIdAdminSession(Proxy proxy)
                          throws OperationFailedException

Gets the session associated with the id administrative service.

Parameters:

proxy - a proxy

Returns:

an IdAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIdAdmin() is false

Compliance:

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

getIdBatchProxyManager

IdBatchProxyManager getIdBatchProxyManager()
                                    throws OperationFailedException

Gets an IdnProxyManager .

Returns:

an IdBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIdBatch() is false

Compliance:

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