org.osid.provisioning.batch

Interface RequestTransactionBatchAdminSession

All Superinterfaces:

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

public interface RequestTransactionBatchAdminSession
extends RequestTransactionAdminSession

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

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

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

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

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

The delete operations delete RequestTransactions in bulk. To unmap a RequestTransaction 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	aliasRequestTransactionss(AliasRequestList aliasRequests) Adds an Id to a RequestTransaction for the purpose of creating compatibility.
CreateResponseList	createRequestTransactions(RequestTransactionBatchFormList requestTransactionForms) Creates a new set of RequestTransactions.
DeleteResponseList	deleteAllRequestTransactions() Deletes all RequestTransactions in this Distributor .
DeleteResponseList	deleteIneffectiveRequestTransactionsByDate(DateTime date) Deletes requests expired before the given date.
DeleteResponseList	deleteRequestTransactions(IdList requestTransactionIds) Deletes requests for the given Ids.
DeleteResponseList	deleteRequestTransactionsForBroker(Id brokerId) Deletes requests for the given broker.
DeleteResponseList	deleteRequestTransactionsForResource(Id resourceId) Deletes requests for the given resource.
RequestTransactionBatchFormList	getRequestTransactionFormsForCreate(RequestTransactionPeerList peers, Type[] requestRecordTypes) Gets the request transaction forms for creating a bunch of new requests.
RequestTransactionBatchFormList	getRequestTransactionFormsForUpdate(IdList requestTransactionIds) Gets the request transaction forms for updating an existing set of requests.
UpdateResponseList	updateRequestTransactions(RequestTransactionBatchFormList requestTransactionForms) Updates existing requests.

Methods inherited from interface org.osid.provisioning.RequestTransactionAdminSession

aliasRequestTransaction, canCancelRequestTransactions, cancelRequestTransaction, canCreateRequestTransactions, canCreateRequestTransactionsWithRecordTypes, canDeleteRequestTransactions, canManageRequestTransactionAliases, canUpdateRequestTransactions, createRequestTransaction, deleteRequestTransaction, getDistributor, getDistributorId, getRequestTransactionFormForCreate, getRequestTransactionFormForUpdate, submitRequestTransaction, updateRequestTransaction

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

getRequestTransactionFormsForCreate

RequestTransactionBatchFormList getRequestTransactionFormsForCreate(RequestTransactionPeerList peers,
                                                                  Type[] requestRecordTypes)
                                                                    throws NotFoundException,
                                                                           OperationFailedException,
                                                                           PermissionDeniedException

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

Parameters:

peers - the relationship peers

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

Returns:

the request transaction forms

Throws:

NotFoundException - a brokerId or resourceId is not found

NullArgumentException - peers or requestRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request transaction forms with given record types

Compliance:

mandatory - This method must be implemented.

createRequestTransactions

CreateResponseList createRequestTransactions(RequestTransactionBatchFormList requestTransactionForms)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

requestTransactionForms - the request transaction forms

Returns:

the create responses

Throws:

NullArgumentException - requestTransactionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRequestTransactionFormsForUpdate

RequestTransactionBatchFormList getRequestTransactionFormsForUpdate(IdList requestTransactionIds)
                                                                    throws NotFoundException,
                                                                           OperationFailedException,
                                                                           PermissionDeniedException

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:

requestTransactionIds - the Ids of the Request

Returns:

the request transaction form

Throws:

NotFoundException - a requestTransactionId is not found

NullArgumentException - requestTransactionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateRequestTransactions

UpdateResponseList updateRequestTransactions(RequestTransactionBatchFormList requestTransactionForms)
                                             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:

requestTransactionForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - requestTransactionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllRequestTransactions

DeleteResponseList deleteAllRequestTransactions()
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Deletes all RequestTransactions in this Distributor .

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRequestTransactions

DeleteResponseList deleteRequestTransactions(IdList requestTransactionIds)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

Deletes requests for the given Ids.

Parameters:

requestTransactionIds - the Ids of the requests to delete

Returns:

the delete responses

Throws:

NullArgumentException - requestTransactionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteRequestTransactionsForResource

DeleteResponseList deleteRequestTransactionsForResource(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.

deleteRequestTransactionsForBroker

DeleteResponseList deleteRequestTransactionsForBroker(Id brokerId)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Deletes requests for the given broker.

Parameters:

brokerId - an Id of a broker

Returns:

the delete responses

Throws:

NullArgumentException - brokerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteIneffectiveRequestTransactionsByDate

DeleteResponseList deleteIneffectiveRequestTransactionsByDate(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.

aliasRequestTransactionss

AliasResponseList aliasRequestTransactionss(AliasRequestList aliasRequests)
                                            throws OperationFailedException,
                                                   PermissionDeniedException

Adds an Id to a RequestTransaction 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 transaction, it is reassigned to the given request transaction 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.