OSID Logo
OSID Specifications
provisioning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.batch.RequestTransactionBatchAdminSession
Implementsosid.provisioning.RequestTransactionAdminSession
Description

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.

MethodgetRequestTransactionFormsForCreate
Description

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

Parametersosid.provisioning.batch.RequestTransactionPeerListpeersthe relationship peers
osid.type.Type[]requestRecordTypesarray of request transaction record types to be included in each create operation or an empty list if none
Returnosid.provisioning.batch.RequestTransactionBatchFormListthe request transaction forms
ErrorsNOT_FOUNDa brokerId or resourceId is not found
NULL_ARGUMENT peers or requestRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request transaction forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateRequestTransactions
Description

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 .

Parametersosid.provisioning.batch.RequestTransactionBatchFormListrequestTransactionFormsthe request transaction forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT requestTransactionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRequestTransactionFormsForUpdate
Description

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

Parametersosid.id.IdListrequestTransactionIdsthe Ids of the Request
Returnosid.provisioning.batch.RequestTransactionBatchFormListthe request transaction form
ErrorsNOT_FOUNDa requestTransactionId is not found
NULL_ARGUMENT requestTransactionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRequestTransactions
Description

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 .

Parametersosid.provisioning.batch.RequestTransactionBatchFormListrequestTransactionFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT requestTransactionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllRequestTransactions
Description

Deletes all RequestTransactions in this Distributor .

Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRequestTransactions
Description

Deletes requests for the given Ids.

Parametersosid.id.IdListrequestTransactionIdsthe Ids of the requests to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT requestTransactionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRequestTransactionsForResource
Description

Deletes requests for the given resource.

Parametersosid.id.IdresourceIdan Id of a resource
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRequestTransactionsForBroker
Description

Deletes requests for the given broker.

Parametersosid.id.IdbrokerIdan Id of a broker
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT brokerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveRequestTransactionsByDate
Description

Deletes requests expired before the given date.

Parametersosid.calendaring.DateTimedatea date
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT date is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasRequestTransactionss
Description

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.

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENT aliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.