OSID Logo
OSID Specifications
provisioning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.batch.RequestBatchAdminSession
Implementsosid.provisioning.RequestAdminSession
Description

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.

MethodgetRequestFormsForCreate
Description

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

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

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 .

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

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

Parametersosid.id.IdListrequestIdsthe Ids of the Request
Returnosid.provisioning.batch.RequestBatchFormListthe request form
ErrorsNOT_FOUNDan requestId is not found
NULL_ARGUMENT requestIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateRequests
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.RequestBatchFormListrequestFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT requestForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllRequests
Description

Deletes all Requests in this Distributor .

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

Deletes requests for the given Ids.

Parametersosid.id.IdListrequestIdsthe Ids of the requests to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT requestIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteRequestsForResource
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.
MethoddeleteRequestsForQueue
Description

Deletes requests for the given queue.

Parametersosid.id.IdqueueIdan Id of a queue
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT queueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveRequestsByDate
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.
MethodaliasRequests
Description

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.

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.