OSID Logo
OSID Specifications
provisioning batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.provisioning.batch.BrokerBatchAdminSession
Implementsosid.provisioning.BrokerAdminSession
Description

This session creates, updates, and deletes Brokers 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 Broker, a BrokerForm is requested using getBrokerFormsForCreate() specifying the desiredrecord Types or none if no record Types are needed. Each of the returned BrokerForms 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 BrokerForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each BrokerForm corresponds to an attempted transaction.

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

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

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

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

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

MethodgetBrokerFormsForCreate
Description

Gets the broker forms for creating a bunch of new brokers.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]brokerRecordTypesarray of broker record types to be included in each create operation or an empty list if none
Returnosid.provisioning.batch.BrokerBatchFormListthe broker forms
ErrorsNULL_ARGUMENT brokerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateBrokers
Description

Creates a new set of Brokers. 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.BrokerBatchFormListbrokerFormsthe broker forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT brokerForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetBrokerFormsForUpdate
Description

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

Parametersosid.id.IdListbrokerIdsthe Ids of the Broker
Returnosid.provisioning.batch.BrokerBatchFormListthe broker form
ErrorsNOT_FOUNDa brokerId is not found
NULL_ARGUMENT brokerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateBrokers
Description

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

Deletes all Brokers in this Distributor .

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

Deletes brokers for the given Ids.

Parametersosid.id.IdListbrokerIdsthe Ids of the brokers to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT brokerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasBrokers
Description

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