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 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. |
changeBranch, initialize, rollbackService
close
supportsAgencyBatchAdmin, supportsAgentBatchAdmin, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
AgentBatchAdminSession getAgentBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk agent
administration service. AgentBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgentBatchAdmin()
is false
optional
- This method must be implemented if
supportsAgentBatchAdmin()
is true.
AgentBatchAdminSession getAgentBatchAdminSessionForAgency(Id agencyId) throws NotFoundException, OperationFailedException
OsidSession
associated with the bulk agent
administration service for the given agency.agencyId
- the Id
of the Agency
AgentBatchAdminSession
NotFoundException
- no Agency
found by
the given Id
NullArgumentException
- agencyId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgentBatchAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsAgentBatchAdmin()
and
supportsVisibleFederation()
are true
AgencyBatchAdminSession getAgencyBatchAdminSession() throws OperationFailedException
OsidSession
associated with the bulk agency
administration service. AgencyBatchAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsAgencyBatchAdmin()
is false
optional
- This method must be implemented if
supportsAgencyBatchAdmin()
is true.