org.osid.authentication.batch

Interface AuthenticationBatchProxyManager

All Superinterfaces:

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

public interface AuthenticationBatchProxyManager
extends OsidProxyManager, AuthenticationBatchProfile

The authentication batch proxy manager provides access to authentication batch sessions and provides interoperability tests for various aspects of this service. Methods in this manager support the passing of a Proxy object. The sessions included in this manager are:

• AgentBatchAdminSession: a session to manage agents in bulk
• AgencyBatchAdminSession: a session to create, modify and delete Agencies in bulk

Method Summary

Methods

Modifier and Type	Method and Description
AgencyBatchAdminSession	getAgencyBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk agency administration service.
AgentBatchAdminSession	getAgentBatchAdminSession(Proxy proxy) Gets the OsidSession associated with the bulk agent administration service.
AgentBatchAdminSession	getAgentBatchAdminSessionForAgency(Id agencyId, Proxy proxy) Gets the OsidSession associated with the bulk agent administration service for the given agency.

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.authentication.batch.AuthenticationBatchProfile

supportsAgencyBatchAdmin, supportsAgentBatchAdmin, supportsVisibleFederation

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

getAgentBatchAdminSession

AgentBatchAdminSession getAgentBatchAdminSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the bulk agent administration service.

Parameters:

proxy - a proxy

Returns:

a AgentBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentBatchAdmin() is false

Compliance:

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

getAgentBatchAdminSessionForAgency

AgentBatchAdminSession getAgentBatchAdminSessionForAgency(Id agencyId,
                                                        Proxy proxy)
                                                          throws NotFoundException,
                                                                 OperationFailedException

Gets the OsidSession associated with the bulk agent administration service for the given agency.

Parameters:

agencyId - the Id of the Agency

proxy - a proxy

Returns:

a AgentBatchAdminSession

Throws:

NotFoundException - no Agency found by the given Id

NullArgumentException - agencyId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgentBatchAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsAgentBatchAdmin() and supportsVisibleFederation() are true

getAgencyBatchAdminSession

AgencyBatchAdminSession getAgencyBatchAdminSession(Proxy proxy)
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk agency administration service.

Parameters:

proxy - a proxy

Returns:

a AgencyBatchAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsAgencyBatchAdmin() is false

Compliance:

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