OSID Logo
OSID Specifications
lexicon batch package
Version 3.0.0
Interfaceosid.lexicon.batch.TextBatchAdminSession
Implementsosid.lexicon.TextAdminSession
Used Byosid.lexicon.batch.LexiconBatchManager
osid.lexicon.batch.LexiconBatchProxyManager
Description

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

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

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

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

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

The delete operations delete Texts in bulk. To unmap a Text from the current Press , the TextPressAssignmentSession should be used. These delete operations attempt to remove the Text itself thus removing it from all known Press catalogs. Bulk delete operations return the results in DeleteResponses .

MethodgetTextFormsForCreate
Description

Gets the texts forms for creating a bunch of new texts.

Parameterscardinalnumberthe number of foms to retrieve
osid.type.Type[]TextRecordTypesarray of text record types to be included in each create operation or an empty list if none
Returnosid.lexicon.batch.TextBatchFormListthe text forms
ErrorsNULL_ARGUMENTTextRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateTexts
Description

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

Parametersosid.lexicon.batch.TextBatchFormListTextFormsthe text forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENTTextForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTextFormsForUpdate
Description

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

Parametersosid.id.IdListTextIdsthe Ids of the Text
Returnosid.lexicon.batch.TextBatchFormListthe text form
ErrorsNOT_FOUNDa TextId is not found
NULL_ARGUMENTTextIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateTexts
Description

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

Parametersosid.lexicon.batch.TextBatchFormListTextFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENTTextForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllTexts
Description

Deletes all Texts in this Press .

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

Deletes texts for the given Ids .

Parametersosid.id.IdListTextIdsthe Ids of the texts to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENTTextIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasTexts
Description

Adds an Id to a Text for the purpose of creating compatibility. The primary Id of the Text is determined by the provider. The new Id is an alias to the primary Id . If the alias is a pointer to another text, it is reassigned to the given text Id .

Parametersosid.transaction.batch.AliasRequestListaliasRequeststhe alias requests
Returnosid.transaction.batch.AliasResponseListthe alias responses
ErrorsNULL_ARGUMENTaliasRequests is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.