OSID Logo
OSID Specifications
hold batch package
Version 3.1.0
Interfaceosid.hold.batch.HoldBatchAdminSession
Implementsosid.hold.HoldAdminSession
Used Byosid.hold.batch.HoldBatchManager
osid.hold.batch.HoldBatchProxyManager
Description

This session creates, updates, and deletes Holds in bulk. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Hold, a HoldForm is requested using getHoldFormsForCreate() specifying the desired issue and record Types or none if no record Types are needed. Each of the returned HoldForms will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once a HoldForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each HoldForm corresponds to an attempted transaction.

The HoldForms returned from getHoldFormsForCreate() may be linked to the originating request through the peer Ids of the HoldForm. In the case where there may be duplicates, any HoldForm of the same peer Ids may be used for a create operation.

Once a batch of HoldForms are submitted for create, a CreateResponse is returned for each HoldForm, although the ordering is not defined. Only errors that pertain to the entire create operation are returned from createHolds(), errors specific to an individual HoldForm are indicated in the corresponding CreateResponse. CreateResponses may be linked to the originating HoldForm through the HoldForm Id.

For updates, HoldForms are requested to the Hold Id that is to be updated using getHoldFormsForUpdate() where the reference Id in the HoldForm may be used to link the request. Similarly, the HoldForm has metadata about the data that can be updated and it can perform validation before submitting the update. The HoldForm can only be used once for a successful update and cannot be reused.

Once a batch of HoldForms are submitted for update, an UpdateResponse is returned for each HoldForm, although the ordering is not defined. Only errors that pertain to the entire update operation are returned from updateHolds(), errors specific to an individual HoldForm are indicated in the corresponding UpdateResponse. UpdateResponses may be linked to the originating HoldForm through the HoldForm Id.

The delete operations delete Holds in bulk. To unmap a Hold from the current Oubliette, the HoldOublietteAssignmentSession should be used. These delete operations attempt to remove the Hold itself thus removing it from all known Oubliette catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetHoldFormsForCreateForAgents
Description

Gets the hold forms for creating a bunch of new holds. A form is returned for each supplied agent and issue pair.

Parametersosid.hold.batch.HoldAgentPeerListpeers 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
Returnosid.hold.batch.HoldBatchFormList the hold forms
ErrorsNOT_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
Compliancemandatory This method must be implemented.
MethodgetHoldFormsForCreateForResources
Description

Gets the hold forms for creating a bunch of new holds. A form is returned for each supplied resource and issue pair.

Parametersosid.hold.batch.HoldResourcePeerListpeers 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
Returnosid.hold.batch.HoldBatchFormList the hold forms
ErrorsNOT_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
Compliancemandatory This method must be implemented.
MethodcreateHolds
Description

Creates a new set of Holds. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse.

Parametersosid.hold.batch.HoldBatchFormListholdForms the hold forms
Returnosid.transaction.batch.CreateResponseList the create responses
ErrorsNULL_ARGUMENT holdForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetHoldFormsForUpdate
Description

Gets the hold forms for updating an existing set of holds. A new hold form should be requested for each update transaction.

Parametersosid.id.IdListholdIds the Ids of the Hold
Returnosid.hold.batch.HoldBatchFormList the hold form
ErrorsNOT_FOUND a holdId is not found
NULL_ARGUMENT holdIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodupdateHolds
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 BatchCreateResponse.

Parametersosid.hold.batch.HoldBatchFormListholdForms the form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseList the update responses
ErrorsNULL_ARGUMENT holdForms is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteAllHolds
Description

Deletes all Holds in this Oubliette.

Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteHolds
Description

Deletes holds for the given Ids.

Parametersosid.id.IdListholdIds the Ids of the holds to delete
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT holdIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteHoldsForIssue
Description

Deletes holds for the given issue.

Parametersosid.id.IdissueId the Id of an issue
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT issueId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteHoldsForAgent
Description

Deletes holds for the given agent.

Parametersosid.id.IdagentId the Id of an agent
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT agentId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteHoldsForResource
Description

Deletes holds for the given resource and any holds for agents related to the given resource.

Parametersosid.id.IdresourceId the Id of a resource
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethoddeleteIneffectiveHoldsByDate
Description

Deletes holds expired before the given date.

Parametersosid.calendaring.DateTimedate a date
Returnosid.transaction.batch.DeleteResponseList the delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodaliasHolds
Description

Adds an Id to a Hold for the purpose of creating compatibility. The primary Id of the Hold is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another hold, it is reassigned to the given hold Id.

Parametersosid.transaction.batch.AliasRequestListaliasRequests the alias requests
Returnosid.transaction.batch.AliasResponseList the alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.