OSID Logo
OSID Specifications
provisioning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.batch.ProvisionableBatchAdminSession
Implementsosid.provisioning.ProvisionableAdminSession
Description

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

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

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

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

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

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

MethodgetProvisionableFormsForCreate
Description

Gets the provisionable forms for creating a bunch of new provisionables. A ProvisionableForm is returned for each pool and resource pair.

Parametersosid.provisioning.batch.ProvisionablePeerListpeersthe relationship peers
osid.type.Type[]provisionableRecordTypesarray of provisionable record types to be included in each create operation or an empty list if none
Returnosid.provisioning.batch.ProvisionableBatchFormListthe provisionable forms
ErrorsNOT_FOUNDa resourceId or poolId is not found
NULL_ARGUMENT peers or provisionableRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request transaction forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateProvisionables
Description

Creates a new set of Provisionables. 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.ProvisionableBatchFormListprovisionableFormsthe provisionable forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT provisionableForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetProvisionableFormsForUpdate
Description

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

Parametersosid.id.IdListprovisionableIdsthe Ids of the Provisionable
Returnosid.provisioning.batch.ProvisionableBatchFormListthe provisionable form
ErrorsNOT_FOUNDa provisionableId is not found
NULL_ARGUMENT provisionableIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateProvisionables
Description

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

Deletes all Provisionables in this Distributor .

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

Deletes provisionables for the given Ids.

Parametersosid.id.IdListprovisionableIdsthe Ids of the provisionables to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT provisionableIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteProvisionablesForResource
Description

Deletes all provisionables 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.
MethoddeleteProvisionablesForPool
Description

Deletes all provisionables for the given pool.

Parametersosid.id.IdpoolIdan Id of a pool
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT poolId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteIneffectiveProvisionablesByDate
Description

Deletes provisionables 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.
MethodaliasProvisionables
Description

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