OSID Logo
OSID Specifications
workflow batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.batch.WorkBatchAdminSession
Implementsosid.workflow.WorkAdminSession
Description

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

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

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

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

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

The delete operations delete Works in bulk. To unmap a Work from the current Office, the WorkOfficeAssignmentSession should be used. These delete operations attempt to remove the Work itself thus removing it from all known Office catalogs. Bulk delete operations return the results in DeleteResponses.

MethodgetWorkFormsForCreate
Description

Gets the work forms for creating a bunch of new works.

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

Creates a new set of Works. 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.WorkBatchFormListworkFormsthe work forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT workForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetWorkFormsForUpdate
Description

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

Parametersosid.id.IdListworkIdsthe Ids of the Work
Returnosid.workflow.batch.WorkBatchFormListthe work form
ErrorsNOT_FOUNDa workId is not found
NULL_ARGUMENT workIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateWorks
Description

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

Deletes all Works in this Office .

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

Deletes works for the given Ids.

Parametersosid.id.IdListworkIdsthe Ids of the works to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT workIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasWorks
Description

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