| Interface | osid.authorization.batch.AuthorizationBatchManager | ||
|---|---|---|---|
| Implements | osid.OsidManager | ||
osid.authorization.batch.AuthorizationBatchProfile | |||
| Description |
The authorization batch manager provides access to authorization batch sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
| ||
| Method | getAuthorizationBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.batch.AuthorizationBatchAdminSession | an AuthorizationBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsAuthorizationBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationBatchAdmin()
is true. | |
| Method | getAuthorizationBatchAdminSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the Vault |
| Return | osid.authorization.batch.AuthorizationBatchAdminSession | an AuthorizationBatchAdminSession | |
| Errors | NOT_FOUND | no Vault found by the given Id | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsAuthorizationBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsAuthorizationBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getFunctionBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.batch.FunctionBatchAdminSession | a FunctionBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsFunctionBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionBatchAdmin()
is true. | |
| Method | getFunctionBatchAdminSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the Vault |
| Return | osid.authorization.batch.FunctionBatchAdminSession | a FunctionBatchAdminSession | |
| Errors | NOT_FOUND | no Vault found by the given Id | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsFunctionBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsFunctionBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getQualifierBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.batch.QualifierBatchAdminSession | a QualifierBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsQualifierBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierBatchAdmin()
is true. | |
| Method | getQualifierBatchAdminSessionForVault | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | vaultId | the Id of the Vault |
| Return | osid.authorization.batch.QualifierBatchAdminSession | a QualifierBatchAdminSession | |
| Errors | NOT_FOUND | no Vault found by the given Id | |
| NULL_ARGUMENT | vaultId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| UNIMPLEMENTED | supportsQualifierBatchAdmin() or
supportsVisibleFederation() is false | ||
| Compliance | optional | This method must be implemented if supportsQualifierBatchAdmin()
and supportsVisibleFederation() are true | |
| Method | getVaultBatchAdminSession | ||
| Description |
Gets the | ||
| Return | osid.authorization.batch.VaultBatchAdminSession | a VaultBatchAdminSession | |
| Errors | OPERATION_FAILED | unable to complete request | |
| UNIMPLEMENTED | supportsVaultBatchAdmin() is false | ||
| Compliance | optional | This method must be implemented if supportsVaultBatchAdmin()
is true. | |