org.osid.provisioning.batch

Interface RequestBatchAdminSession

All Superinterfaces:

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

public interface RequestBatchAdminSession
extends RequestAdminSession

This session creates, updates, and deletes Requests 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 an Request, an RequestForm is requested using getRequestFormsForCreate() specifying the desired queue, resource, record Types or none if no record Types are needed. Each of the returned RequestForms 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 an RequestForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each RequestForm corresponds to an attempted transaction.

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

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

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

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

The delete operations delete Requests in bulk. To unmap an Request from the current Distributor, the RequestDistributorAssignmentSession should be used. These delete operations attempt to remove the Request itself thus removing it from all known Distributor catalogs. Bulk delete operations return the results in DeleteResponses.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasRequests(AliasRequestList aliasRequests) Adds an Id to an Request for the purpose of creating compatibility.
CreateResponseList	createRequests(RequestBatchFormList requestForms) Creates a new set of Requests.
DeleteResponseList	deleteAllRequests() Deletes all Requests in this Distributor .
DeleteResponseList	deleteIneffectiveRequestsByDate(DateTime date) Deletes requests expired before the given date.
DeleteResponseList	deleteRequests(IdList requestIds) Deletes requests for the given Ids.
DeleteResponseList	deleteRequestsForQueue(Id queueId) Deletes requests for the given queue.
DeleteResponseList	deleteRequestsForResource(Id resourceId) Deletes requests for the given resource.
RequestBatchFormList	getRequestFormsForCreate(RequestPeerList peers, Type[] requestRecordTypes) Gets the request forms for creating a bunch of new requests.
RequestBatchFormList	getRequestFormsForUpdate(IdList requestIds) Gets the request forms for updating an existing set of requests.
UpdateResponseList	updateRequests(RequestBatchFormList requestForms) Updates existing requests.

Methods inherited from interface org.osid.provisioning.RequestAdminSession

aliasRequest, canCancelRequests, cancelRequest, canCreateRequests, canCreateRequestWithRecordTypes, canDeleteRequests, canManageRequestAliases, canUpdateRequests, createRequest, deleteRequest, getDistributor, getDistributorId, getRequestFormForCreate, getRequestFormForUpdate, submitRequest, updateRequest

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

getRequestFormsForCreate

RequestBatchFormList getRequestFormsForCreate(RequestPeerList peers,
                                            Type[] requestRecordTypes)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the request forms for creating a bunch of new requests. A form is returned for each queue and resource pair.

Parameters:

peers - the relationship peers

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

Returns:

the request forms

Throws:

NotFoundException - a queueId or resourceId is not found

NullArgumentException - peers or requestRecordTypes 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.

createRequests

CreateResponseList createRequests(RequestBatchFormList requestForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

requestForms - the request forms

Returns:

the create responses

Throws:

NullArgumentException - requestForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestFormsForUpdate

RequestBatchFormList getRequestFormsForUpdate(IdList requestIds)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

requestIds - the Ids of the Request

Returns:

the request form

Throws:

NotFoundException - an requestId is not found

NullArgumentException - requestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateRequests

UpdateResponseList updateRequests(RequestBatchFormList requestForms)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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 BatchCreateResponse .

Parameters:

requestForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - requestForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllRequests

DeleteResponseList deleteAllRequests()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Deletes all Requests in this Distributor .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRequests

DeleteResponseList deleteRequests(IdList requestIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

Deletes requests for the given Ids.

Parameters:

requestIds - the Ids of the requests to delete

Returns:

the delete responses

Throws:

NullArgumentException - requestIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRequestsForResource

DeleteResponseList deleteRequestsForResource(Id resourceId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Deletes requests for the given resource.

Parameters:

resourceId - an 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.

deleteRequestsForQueue

DeleteResponseList deleteRequestsForQueue(Id queueId)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Deletes requests for the given queue.

Parameters:

queueId - an Id of a queue

Returns:

the delete responses

Throws:

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveRequestsByDate

DeleteResponseList deleteIneffectiveRequestsByDate(DateTime date)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Deletes requests 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.

aliasRequests

AliasResponseList aliasRequests(AliasRequestList aliasRequests)
                                throws OperationFailedException,
                                       PermissionDeniedException

Adds an Id to an Request for the purpose of creating compatibility. The primary Id of the Request is determined by the provider. The new Id is an alias to the primary Id. If the alias is a pointer to another request, it is reassigned to the given request 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.