org.osid.authentication.batch

Interface AuthenticationBatchManager

All Superinterfaces:

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

public interface AuthenticationBatchManager
extends OsidManager, AuthenticationBatchProfile

The authentication batch manager provides access to authentication batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• AgentBatchAdminSession: a session to create, modify and delete 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() Gets the OsidSession associated with the bulk agency administration service.
AgentBatchAdminSession	getAgentBatchAdminSession() Gets the OsidSession associated with the bulk agent administration service.
AgentBatchAdminSession	getAgentBatchAdminSessionForAgency(Id agencyId) Gets the OsidSession associated with the bulk agent administration service for the given agency.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

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

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

Gets the OsidSession associated with the bulk agent administration service.

Returns:

an AgentBatchAdminSession

Throws:

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)
                                                          throws NotFoundException,
                                                                 OperationFailedException

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

Parameters:

agencyId - the Id of the Agency

Returns:

an AgentBatchAdminSession

Throws:

NotFoundException - no Agency found by the given Id

NullArgumentException - agencyId 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()
                                                   throws OperationFailedException

Gets the OsidSession associated with the bulk agency administration service.

Returns:

an AgencyBatchAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsAgencyBatchAdmin() is false

Compliance:

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