org.osid.hold.batch

Interface HoldBatchAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, HoldAdminSession, OsidSession

public interface HoldBatchAdminSession
extends HoldAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasHolds(AliasRequestList aliasRequests) Adds an Id to a Hold for the purpose of creating compatibility.
CreateResponseList	createHolds(HoldBatchFormList holdForms) Creates a new set of Holds.
DeleteResponseList	deleteAllHolds() Deletes all Holds in this Oubliette .
DeleteResponseList	deleteHolds(IdList holdIds) Deletes holds for the given Ids.
DeleteResponseList	deleteHoldsForAgent(Id agentId) Deletes holds for the given agent.
DeleteResponseList	deleteHoldsForIssue(Id issueId) Deletes holds for the given issue.
DeleteResponseList	deleteHoldsForResource(Id resourceId) Deletes holds for the given resource and any holds for agents related to the given resource.
DeleteResponseList	deleteIneffectiveHoldsByDate(DateTime date) Deletes holds expired before the given date.
HoldBatchFormList	getHoldFormsForCreateForAgents(HoldAgentPeerList peers, Type[] holdRecordTypes) Gets the hold forms for creating a bunch of new holds.
HoldBatchFormList	getHoldFormsForCreateForResources(HoldResourcePeerList peers, Type[] holdRecordTypes) Gets the hold forms for creating a bunch of new holds.
HoldBatchFormList	getHoldFormsForUpdate(IdList holdIds) Gets the hold forms for updating an existing set of holds.
UpdateResponseList	updateHolds(HoldBatchFormList holdForms) Updates existing holds.

Methods inherited from interface org.osid.hold.HoldAdminSession

aliasHold, canCreateHolds, canCreateHoldWithRecordTypes, canDeleteHolds, canManageHoldAliases, canUpdateHolds, createHold, deleteHold, getHoldFormForCreateForAgent, getHoldFormForCreateForResource, getHoldFormForUpdate, getOubliette, getOublietteId, updateHold

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getHoldFormsForCreateForAgents

HoldBatchFormList getHoldFormsForCreateForAgents(HoldAgentPeerList peers,
                                               Type[] holdRecordTypes)
                                                 throws NotFoundException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

peers - the hold peers

holdRecordTypes - array of hold record types to be included in each create operation or an empty list if none

Returns:

the hold forms

Throws:

NotFoundException - an issueId or agentId is not found

NullArgumentException - peers or holdRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

getHoldFormsForCreateForResources

HoldBatchFormList getHoldFormsForCreateForResources(HoldResourcePeerList peers,
                                                  Type[] holdRecordTypes)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

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

Parameters:

peers - the hold peers

holdRecordTypes - array of hold record types to be included in each create operation or an empty list if none

Returns:

the hold forms

Throws:

NotFoundException - an issueId or resourceId is not found

NullArgumentException - peers or holdRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createHolds

CreateResponseList createHolds(HoldBatchFormList holdForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

holdForms - the hold forms

Returns:

the create responses

Throws:

NullArgumentException - holdForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getHoldFormsForUpdate

HoldBatchFormList getHoldFormsForUpdate(IdList holdIds)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

holdIds - the Ids of the Hold

Returns:

the hold form

Throws:

NotFoundException - a holdId is not found

NullArgumentException - holdIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateHolds

UpdateResponseList updateHolds(HoldBatchFormList holdForms)
                               throws OperationFailedException,
                                      PermissionDeniedException

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 .

Parameters:

holdForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - holdForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllHolds

DeleteResponseList deleteAllHolds()
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes all Holds in this Oubliette .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteHolds

DeleteResponseList deleteHolds(IdList holdIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

Deletes holds for the given Ids.

Parameters:

holdIds - the Ids of the holds to delete

Returns:

the delete responses

Throws:

NullArgumentException - holdIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteHoldsForIssue

DeleteResponseList deleteHoldsForIssue(Id issueId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes holds for the given issue.

Parameters:

issueId - the Id of an issue

Returns:

the delete responses

Throws:

NullArgumentException - issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteHoldsForAgent

DeleteResponseList deleteHoldsForAgent(Id agentId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

Deletes holds for the given agent.

Parameters:

agentId - the Id of an agent

Returns:

the delete responses

Throws:

NullArgumentException - agentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteHoldsForResource

DeleteResponseList deleteHoldsForResource(Id resourceId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

resourceId - the Id of a resource

Returns:

the delete responses

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveHoldsByDate

DeleteResponseList deleteIneffectiveHoldsByDate(DateTime date)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes holds expired before the given date.

Parameters:

date - a date

Returns:

the delete responses

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasHolds

AliasResponseList aliasHolds(AliasRequestList aliasRequests)
                             throws OperationFailedException,
                                    PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.