Interface | osid.provisioning.batch.RequestTransactionBatchAdminSession | ||
---|---|---|---|
Implements | osid.provisioning.RequestTransactionAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getRequestTransactionFormsForCreate | ||
Description |
Gets the request transaction forms for creating a bunch of new requests. A form is returned for each broker and resource pair. | ||
Parameters | osid.provisioning.batch.RequestTransactionPeerList | peers | the relationship peers |
osid.type.Type[] | requestRecordTypes | array of request transaction record types to be included in each create operation or an empty list if none | |
Return | osid.provisioning.batch.RequestTransactionBatchFormList | the request transaction forms | |
Errors | NOT_FOUND | a brokerId or resourceId is not found | |
NULL_ARGUMENT | peers or requestRecordTypes is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request transaction forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createRequestTransactions | ||
Description |
Creates a new set of | ||
Parameters | osid.provisioning.batch.RequestTransactionBatchFormList | requestTransactionForms | the request transaction forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | requestTransactionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequestTransactionFormsForUpdate | ||
Description |
Gets the request transaction forms for updating an existing set of requests. A new request transaction form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | requestTransactionIds | the Ids of the Request |
Return | osid.provisioning.batch.RequestTransactionBatchFormList | the request transaction form | |
Errors | NOT_FOUND | a requestTransactionId is not found | |
NULL_ARGUMENT | requestTransactionIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRequestTransactions | ||
Description |
Updates existing requests. This method returns an error
if the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.provisioning.batch.RequestTransactionBatchFormList | requestTransactionForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | requestTransactionForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllRequestTransactions | ||
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 | deleteRequestTransactions | ||
Description |
Deletes requests for the given | ||
Parameters | osid.id.IdList | requestTransactionIds | the Ids of the requests to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | requestTransactionIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteRequestTransactionsForResource | ||
Description |
Deletes requests 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 | deleteRequestTransactionsForBroker | ||
Description |
Deletes requests for the given broker. | ||
Parameters | osid.id.Id | brokerId | an Id of a broker |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | brokerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteIneffectiveRequestTransactionsByDate | ||
Description |
Deletes requests 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 | aliasRequestTransactionss | ||
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. |