Interface | osid.control.batch.TriggerBatchAdminSession | ||
---|---|---|---|
Implements | osid.control.TriggerAdminSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a The Once a batch of For updates, Once a batch of The delete operations delete | ||
Method | getTriggerFormsForCreate | ||
Description |
Gets the trigger forms for creating a bunch of new triggers. A form is retrieved for each controller. | ||
Parameters | osid.id.IdList | controllerIds | list of controller Ids |
osid.type.Type[] | triggerRecordTypes | array of trigger record types to be included in each create operation or an empty list if none | |
Return | osid.control.batch.TriggerBatchFormList | the trigger forms | |
Errors | NOT_FOUND | a controllerId is not found | |
NULL_ARGUMENT | controllerIds or triggerRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to request forms with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createTriggers | ||
Description |
Creates a new set of | ||
Parameters | osid.control.batch.TriggerBatchFormList | triggerForms | the trigger forms |
Return | osid.transaction.batch.CreateResponseList | the create responses | |
Errors | NULL_ARGUMENT | triggerForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getTriggerFormsForUpdate | ||
Description |
Gets the trigger forms for updating an existing set of triggers. A new trigger form should be requested for each update transaction. | ||
Parameters | osid.id.IdList | triggerIds | the Ids of the Trigger |
Return | osid.control.batch.TriggerBatchFormList | the trigger form | |
Errors | NOT_FOUND | a triggerId is not found | |
NULL_ARGUMENT | triggerIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateTriggers | ||
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 | ||
Parameters | osid.control.batch.TriggerBatchFormList | triggerForms | the form containing the elements to be updated |
Return | osid.transaction.batch.UpdateResponseList | the update responses | |
Errors | NULL_ARGUMENT | triggerForms is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteAllTriggers | ||
Description |
Deletes all | ||
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteTriggers | ||
Description |
Deletes triggers for the given | ||
Parameters | osid.id.IdList | triggerIds | the Ids of the triggers to delete |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | triggerIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteTriggersForController | ||
Description |
Deletes triggers for the given | ||
Parameters | osid.id.Id | controllerId | a controller Id |
Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
Errors | NULL_ARGUMENT | controllerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | aliasTriggers | ||
Description |
Adds an | ||
Parameters | osid.transaction.batch.AliasRequestList | aliasRequests | the alias requests |
Return | osid.transaction.batch.AliasResponseList | the alias responses | |
Errors | NULL_ARGUMENT | aliasRequests is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |