Interface AuthenticationBatchProxyManager
- All Superinterfaces:
AuthenticationBatchProfile, AutoCloseable, Closeable, OsidProfile, OsidProxyManager, 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 deleteAgenciesin bulk
-
Method Summary
Modifier and TypeMethodDescriptiongetAgencyBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk agency administration service.getAgentBatchAdminSession(Proxy proxy) Gets theOsidSessionassociated with the bulk agent administration service.getAgentBatchAdminSessionForAgency(Id agencyId, Proxy proxy) Gets theOsidSessionassociated with the bulk agent administration service for the given agency.Methods inherited from interface AuthenticationBatchProfile
supportsAgencyBatchAdmin, supportsAgentBatchAdmin, supportsVisibleFederationModifier and TypeMethodDescriptionbooleanTests if bulk administration of agencies is available.booleanTests if bulk administration of agents is available.booleanTests if federation is visible.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getAgentBatchAdminSession
Gets theOsidSessionassociated with the bulk agent administration service.- Parameters:
proxy- a proxy- Returns:
- a
AgentBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAgentBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAgentBatchAdmin()} is {@code true} .
-
getAgentBatchAdminSessionForAgency
AgentBatchAdminSession getAgentBatchAdminSessionForAgency(Id agencyId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the bulk agent administration service for the given agency.- Parameters:
agencyId- theIdof theAgencyproxy- a proxy- Returns:
- a
AgentBatchAdminSession - Throws:
NotFoundException- noAgencyfound by the givenIdNullArgumentException-agencyIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAgentBatchAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAgentBatchAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getAgencyBatchAdminSession
Gets theOsidSessionassociated with the bulk agency administration service.- Parameters:
proxy- a proxy- Returns:
- a
AgencyBatchAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAgencyBatchAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAgencyBatchAdmin()} is {@code true} .
-