OSID Logo
OSID Specifications
workflow batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.batch.OfficeBatchAdminSession
Implementsosid.workflow.OfficeAdminSession
Description

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

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

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

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

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

The delete operations delete Offices in bulk. Bulk delete operations return the results in DeleteResponses.

MethodgetOfficeFormsForCreate
Description

Gets the office forms for creating a bunch of new offices.

Parameterscardinalnumberthe number of forms to retrieve
osid.type.Type[]officeRecordTypesarray of office record types to be included in each create operation or an empty list if none
Returnosid.workflow.batch.OfficeBatchFormListthe office forms
ErrorsNULL_ARGUMENT officeRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateOffices
Description

Creates a new set of Offices. This method returns an error if the entire operation fails. Otherwise, the status of an individual create operation is indicated in the BatchCreateResponse .

Parametersosid.workflow.batch.OfficeBatchFormListofficeFormsthe office forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT officeForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetOfficeFormsForUpdate
Description

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

Parametersosid.id.IdListofficeIdsthe Ids of the Office
Returnosid.workflow.batch.OfficeBatchFormListthe office form
ErrorsNOT_FOUNDan officeId is not found
NULL_ARGUMENT officeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateOffices
Description

Updates existing offices. This method returns an error if the entire operation fails. Otherwise, the status of an individual update operation is indicated in the BatchCreateResponse .

Parametersosid.workflow.batch.OfficeBatchFormListofficeFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT officeForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllOffices
Description

Deletes all Offices.

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

Deletes offices for the given Ids.

Parametersosid.id.IdListofficeIdsthe Ids of the offices to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT officeIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasOffices
Description

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