Interface | osid.authorization.batch.AuthorizationBatchAdminSession | ||
---|---|---|---|
Implements | osid.authorization.AuthorizationAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getAuthorizationFormsForCreateForAgents | ||
Description |
Gets the authorization forms for creating a bunch of new authorizations using agents. An AuthorizationForm is returned for each qualifier and agent pair. | ||
Parameters | osid.authorization.batch.AuthorizationAgentPeerList | peers | the authorization peers |
osid.type.Type[] | authorizationRecordTypes | array of authorization record types to be included in each create operation or an empty list if none | |
Return | osid.authorization.batch.AuthorizationBatchFormList | the authorization forms | |
Errors | NOT_FOUND | an agentId, functionId, or qualifierId is not
found | |
NULL_ARGUMENT | peers or authorizationRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationFormsForCreateForResources | ||
Description |
Gets the authorization forms for creating a bunch of new authorizations using resources. An AuthorizationForm is returned for each qualifier and agent pair. | ||
Parameters | osid.authorization.batch.AuthorizationResourcePeerList | peers | the authorization peers |
osid.type.Type[] | authorizationRecordTypes | array of authorization record types to be included in each create operation or an empty list if none | |
Return | osid.authorization.batch.AuthorizationBatchFormList | the authorization forms | |
Errors | NOT_FOUND | a resourceId, functionId, or qualifierId is
not found | |
NULL_ARGUMENT | peers or authorizationRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationFormsForCreateForResourcesAndTrusts | ||
Description |
Gets the authorization forms for creating a bunch of new authorizations using resources and trusts. An AuthorizationForm is returned for each qualifier and agent pair. | ||
Parameters | osid.authorization.batch.AuthorizationTrustPeerList | peers | the authorization peers |
osid.type.Type[] | authorizationRecordTypes | array of authorization record types to be included in each create operation or an empty list if none | |
Return | osid.authorization.batch.AuthorizationBatchFormList | the authorization forms | |
Errors | NOT_FOUND | a resourceId, trustId, functionId, or qualifierId
is not found | |
NULL_ARGUMENT | peers or authorizationRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createAuthorizations | ||
Description |
Creates a new set of | ||
Parameters | osid.authorization.batch.AuthorizationBatchFormList | authorizationForms | the authorization forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | authorizationForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationFormsForUpdate | ||
Description |
Gets the authorization forms for updating an existing set of authorizations. A new authorization form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | authorizationIds | the Ids of the Authorization |
Return | osid.authorization.batch.AuthorizationBatchFormList | the authorization form | |
Errors | NOT_FOUND | an authorizationId is not found | |
NULL_ARGUMENT | authorizationIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAuthorizations | ||
Description |
Updates existing authorizations. This method returns an
error if the entire operation fails. Otherwise, the status
of an individual update operation is indicated in the
| ||
Parameters | osid.authorization.batch.AuthorizationBatchFormList | authorizationForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | authorizationForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllAuthorizations | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAuthorizations | ||
Description |
Deletes authorizations for the given | ||
Parameters | osid.id.IdList | authorizationIds | the Ids of the authorizations to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | authorizationIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAuthorizationsForResource | ||
Description |
Deletes all authorizations for the given resource. | ||
Parameters | osid.id.Id | resourceId | an Id of a resource |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAuthorizationsForQualifier | ||
Description |
Deletes all authorizations for the given qualifier. | ||
Parameters | osid.id.Id | qualifierId | an Id of a qualifier |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | qualifierId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveAuthorizationsByDate | ||
Description |
Deletes authorizations expired before the given date. | ||
Parameters | osid.calendaring.DateTime | date | a date |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | date is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasAuthorizations | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |