OSID Logo
OSID Specifications
authentication batch package
Version 3.1.0
Interfaceosid.authentication.batch.AuthenticationBatchManager
Implementsosid.OsidManager
osid.authentication.batch.AuthenticationBatchProfile
Used Byosid.authentication.AuthenticationManager
Description

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
MethodgetAgentBatchAdminSession
Description

Gets the OsidSession associated with the bulk agent administration service.

Returnosid.authentication.batch.AgentBatchAdminSession an AgentBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgentBatchAdmin() is false
Complianceoptional This method must be implemented if supportsAgentBatchAdmin() is true.
MethodgetAgentBatchAdminSessionForAgency
Description

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

Parametersosid.id.IdagencyId the Id of the Agency
Returnosid.authentication.batch.AgentBatchAdminSession an AgentBatchAdminSession
ErrorsNOT_FOUND no Agency found by the given Id
NULL_ARGUMENT agencyId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgentBatchAdmin() or supportsVisibleFederation() is false
Complianceoptional This method must be implemented if supportsAgentBatchAdmin() and supportsVisibleFederation() are true
MethodgetAgencyBatchAdminSession
Description

Gets the OsidSession associated with the bulk agency administration service.

Returnosid.authentication.batch.AgencyBatchAdminSession an AgencyBatchAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsAgencyBatchAdmin() is false
Complianceoptional This method must be implemented if supportsAgencyBatchAdmin() is true.