org.osid.id

Interface IdProxyManager

All Superinterfaces:

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

Methods

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

supportsIdAdmin, supportsIdBatch, supportsIdIssue, supportsIdLookup

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

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 supportsIdLookup() is 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 supportsIdIssue() is 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 supportsIdAdmin() is 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 supportsIdBatch() is true.