OSID Logo
OSID Specifications
authorization batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.batch.AuthorizationBatchProxyManager
Implementsosid.OsidProxyManager
osid.authorization.batch.AuthorizationBatchProfile
Description

The authorization batch proxy manager provides access to authorization 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:

  • AuthorizationBatchAdminSession: a session to create, modify and delete authorizations in bulk
  • FunctionBatchSession: a session to create, modify and delete functions in bulk
  • QualifierBatchAdminSession: a session to create, modify and delete qualifiers in bulk
  • VaultBatchAdminSession: a session to create, modify and delete vaults in bulk
MethodgetAuthorizationBatchAdminSession
Description

Gets the OsidSession associated with the bulk authorization administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authorization.batch.AuthorizationBatchAdminSessionan AuthorizationBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationBatchAdmin() is true.
MethodgetAuthorizationBatchAdminSessionForVault
Description

Gets the OsidSession associated with the bulk authorization administration service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.proxy.Proxyproxya proxy
Returnosid.authorization.batch.AuthorizationBatchAdminSessionan AuthorizationBatchAdminSession
ErrorsNOT_FOUNDno Vault found by the given Id
NULL_ARGUMENT vaultId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsAuthorizationBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsAuthorizationBatchAdmin() and supportsVisibleFederation() are true
MethodgetFunctionBatchAdminSession
Description

Gets the OsidSession associated with the bulk function administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authorization.batch.FunctionBatchAdminSessiona FunctionBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFunctionBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsFunctionBatchAdmin() is true.
MethodgetFunctionBatchAdminSessionForVault
Description

Gets the OsidSession associated with the bulk function administration service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.proxy.Proxyproxya proxy
Returnosid.authorization.batch.FunctionBatchAdminSessiona FunctionBatchAdminSession
ErrorsNOT_FOUNDno Vault found by the given Id
NULL_ARGUMENT vaultId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsFunctionBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsFunctionBatchAdmin() and supportsVisibleFederation() are true
MethodgetQualifierBatchAdminSession
Description

Gets the OsidSession associated with the bulk qualifier administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authorization.batch.QualifierBatchAdminSessiona QualifierBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQualifierBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsQualifierBatchAdmin() is true.
MethodgetQualifierBatchAdminSessionForVault
Description

Gets the OsidSession associated with the bulk qualifier administration service for the given vault.

Parametersosid.id.IdvaultIdthe Id of the Vault
osid.proxy.Proxyproxya proxy
Returnosid.authorization.batch.QualifierBatchAdminSessiona QualifierBatchAdminSession
ErrorsNOT_FOUNDno Vault found by the given Id
NULL_ARGUMENT vaultId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsQualifierBatchAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQualifierBatchAdmin() and supportsVisibleFederation() are true
MethodgetVaultBatchAdminSession
Description

Gets the OsidSession associated with the bulk vault administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.authorization.batch.VaultBatchAdminSessiona VaultBatchAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsVaultBatchAdmin() is false
ComplianceoptionalThis method must be implemented if supportsVaultBatchAdmin() is true.