OSID Logo
OSID Specifications
provisioning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.batch.ProvisionBatchAdminSession
Implementsosid.provisioning.ProvisionAdminSession
Description

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

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

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

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

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

The delete operations delete Provisions in bulk. To unmap a Provision from the current Distributor, the ProvisionDistributorAssignmentSession should be used. These delete operations attempt to remove the Provision itself thus removing it from all known Distributor catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetProvisionFormsForCreate
Description

Gets the provision forms for creating a bunch of new provisions. A form is returned for each supplied provisionable, request, and broker.

Parameterscardinalpeersa list of provision peers
osid.type.Type[]provisionRecordTypesarray of provision record types to be included in each create operation or an empty list if none
Returnosid.provisioning.batch.ProvisionBatchFormListthe provision forms
ErrorsNOT_FOUNDa provisionableId, requestId, or brokerId is not found
NULL_ARGUMENT peers or provisionRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateProvisions
Description

Creates a new set of Provisions. 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.ProvisionBatchFormListprovisionFormsthe provision forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT provisionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProvisionFormsForUpdate
Description

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

Parametersosid.id.IdListprovisionIdsthe Ids of the Provision
Returnosid.provisioning.batch.ProvisionBatchFormListthe provision form
ErrorsNOT_FOUNDa provisionId is not found
NULL_ARGUMENT provisionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateProvisions
Description

Updates existing provisions. 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.ProvisionBatchFormListprovisionFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT provisionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllProvisions
Description

Deletes all Provisions in this Distributor .

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

Deletes provisions for the given Ids.

Parametersosid.id.IdListprovisionIdsthe Ids of the provisions to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT provisionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteProvisionsForBroker
Description

Deletes provisions for the given broker.

Parametersosid.id.IdbrokerIdthe 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.
MethoddeleteProvisionsForProvisionable
Description

Deletes provisions for the given provisionable.

Parametersosid.id.IdprovisionableIdthe Id of a provisionable
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT provisionableId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteProvisionsForRecipient
Description

Deletes provisions for the given recipient.

Parametersosid.id.IdresourceIdthe 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.
MethoddeleteProvisionsForRequest
Description

Deletes provisions for the given request.

Parametersosid.id.IdrequestIdthe Id of a request
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT requestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveProvisionsByDate
Description

Deletes provisions 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.
MethodaliasProvisions
Description

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