Interface | osid.hold.batch.HoldBatchAdminSession | ||
---|---|---|---|
Implements | osid.hold.HoldAdminSession | ||
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 | getHoldFormsForCreateForAgents | ||
Description |
Gets the hold forms for creating a bunch of new holds. A form is returned for each supplied agent and issue pair. | ||
Parameters | osid.hold.batch.HoldAgentPeerList | peers | the hold peers |
osid.type.Type[] | holdRecordTypes | array of hold record types to be included in each create operation or an empty list if none | |
Return | osid.hold.batch.HoldBatchFormList | the hold forms | |
Errors | NOT_FOUND | an issueId or agentId is not found | |
NULL_ARGUMENT | peers or holdRecordTypes 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 | getHoldFormsForCreateForResources | ||
Description |
Gets the hold forms for creating a bunch of new holds. A form is returned for each supplied resource and issue pair. | ||
Parameters | osid.hold.batch.HoldResourcePeerList | peers | the hold peers |
osid.type.Type[] | holdRecordTypes | array of hold record types to be included in each create operation or an empty list if none | |
Return | osid.hold.batch.HoldBatchFormList | the hold forms | |
Errors | NOT_FOUND | an issueId or resourceId is not found | |
NULL_ARGUMENT | peers or holdRecordTypes 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 | createHolds | ||
Description |
Creates a new set of | ||
Parameters | osid.hold.batch.HoldBatchFormList | holdForms | the hold forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | holdForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getHoldFormsForUpdate | ||
Description |
Gets the hold forms for updating an existing set of holds. A new hold form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | holdIds | the Ids of the Hold |
Return | osid.hold.batch.HoldBatchFormList | the hold form | |
Errors | NOT_FOUND | a holdId is not found | |
NULL_ARGUMENT | holdIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateHolds | ||
Description |
Updates existing holds. This method returns an error if
the entire operation fails. Otherwise, the status of an
individual update operation is indicated in the | ||
Parameters | osid.hold.batch.HoldBatchFormList | holdForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | holdForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllHolds | ||
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 | deleteHolds | ||
Description |
Deletes holds for the given | ||
Parameters | osid.id.IdList | holdIds | the Ids of the holds to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | holdIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteHoldsForIssue | ||
Description |
Deletes holds for the given issue. | ||
Parameters | osid.id.Id | issueId | the Id of an issue |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | issueId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteHoldsForAgent | ||
Description |
Deletes holds for the given agent. | ||
Parameters | osid.id.Id | agentId | the Id of an agent |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | agentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteHoldsForResource | ||
Description |
Deletes holds for the given resource and any holds for agents related to the given resource. | ||
Parameters | osid.id.Id | resourceId | the 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 | deleteIneffectiveHoldsByDate | ||
Description |
Deletes holds 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 | aliasHolds | ||
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. |