OSID Logo
OSID Specifications
control batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.batch.TriggerBatchAdminSession
Implementsosid.control.TriggerAdminSession
Description

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

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

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

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

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

The delete operations delete Triggers in bulk. To unmap a Trigger from the current System, the TriggerSystemAssignmentSession should be used. These delete operations attempt to remove the Trigger itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteTriggers.

MethodgetTriggerFormsForCreate
Description

Gets the trigger forms for creating a bunch of new triggers. A form is retrieved for each controller.

Parametersosid.id.IdListcontrollerIdslist of controller Ids
osid.type.Type[]triggerRecordTypesarray of trigger record types to be included in each create operation or an empty list if none
Returnosid.control.batch.TriggerBatchFormListthe trigger forms
ErrorsNOT_FOUNDa controllerId is not found
NULL_ARGUMENT controllerIds or triggerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateTriggers
Description

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

Parametersosid.control.batch.TriggerBatchFormListtriggerFormsthe trigger forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT triggerForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetTriggerFormsForUpdate
Description

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

Parametersosid.id.IdListtriggerIdsthe Ids of the Trigger
Returnosid.control.batch.TriggerBatchFormListthe trigger form
ErrorsNOT_FOUNDa triggerId is not found
NULL_ARGUMENT triggerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateTriggers
Description

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

Parametersosid.control.batch.TriggerBatchFormListtriggerFormsthe form containing the elements to be updated
Returnosid.transaction.batch.UpdateResponseListthe update responses
ErrorsNULL_ARGUMENT triggerForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteAllTriggers
Description

Deletes all Triggers in this System.

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

Deletes triggers for the given Ids.

Parametersosid.id.IdListtriggerIdsthe Ids of the triggers to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT triggerIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteTriggersForController
Description

Deletes triggers for the given Controller.

Parametersosid.id.IdcontrollerIda controller Id
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT controllerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasTriggers
Description

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