OSID Logo
OSID Specifications
authentication batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.batch.AuthenticationBatchProxyManager
Implementsosid.OsidProxyManager
osid.authentication.batch.AuthenticationBatchProfile
Description

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

MethodgetAgentBatchAdminSession
Description

Gets the OsidSession associated with the bulk agent administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authentication.batch.AgentBatchAdminSessiona AgentBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgentBatchAdmin() is false
ComplianceoptionalThis 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.IdagencyIdthe Id of the Agency
osid.proxy.Proxyproxya proxy
Returnosid.authentication.batch.AgentBatchAdminSessiona AgentBatchAdminSession
ErrorsNOT_FOUNDno Agency found by the given Id
NULL_ARGUMENT agencyId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgentBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAgentBatchAdmin() and supportsVisibleFederation() are true
MethodgetAgencyBatchAdminSession
Description

Gets the OsidSession associated with the bulk agency administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authentication.batch.AgencyBatchAdminSessiona AgencyBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAgencyBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAgencyBatchAdmin() is true.