OSID Logo
OSID Specifications
control batch package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.batch.ActionGroupBatchAdminSession
Implementsosid.control.ActionGroupAdminSession
Description

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

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

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

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

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

The delete operations delete ActionGroups in bulk. To unmap an ActionGroup from the current System, the ActionGroupSystemAssignmentSession should be used. These delete operations attempt to remove the ActionGroup itself thus removing it from all known System catalogs. Bulk delete operations return the results in DeleteActionGroups.

MethodgetActionGroupFormsForCreate
Description

Gets the action group forms for creating a bunch of new action groups.

Parameterscardinalnthe number of forms to retrieve
osid.type.Type[]actionGroupRecordTypesarray of action group record types to be included in each create operation or an empty list if none
Returnosid.control.batch.ActionGroupBatchFormListthe action group forms
ErrorsNULL_ARGUMENT actionGroupRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateActionGroups
Description

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

Parametersosid.control.batch.ActionGroupBatchFormListactionGroupFormsthe action group forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT actionGroupForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActionGroupFormsForUpdate
Description

Gets the action group forms for updating an existing set of action groups. A new action group form should be requested for each update transaction.

Parametersosid.id.IdListactionGroupIdsthe Ids of the ActionGroup
Returnosid.control.batch.ActionGroupBatchFormListthe action group form
ErrorsNOT_FOUNDan actionGroupId is not found
NULL_ARGUMENT actionGroupIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateActionGroups
Description

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

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

Deletes all ActionGroups in this System.

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

Deletes action groups for the given Ids.

Parametersosid.id.IdListactionGroupIdsthe Ids of the action groups to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT actionGroupIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasActionGroups
Description

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

Gets the action forms for creating a bunch of new actions. A form is retrieved for each action group.

Parametersosid.id.IdListactionGroupIdslist of action groups
osid.type.Type[]actionRecordTypesarray of action record types to be included in each create operation or an empty list if none
Returnosid.control.batch.ActionBatchFormListthe action forms
ErrorsNOT_FOUNDan actionGroupId is not found
NULL_ARGUMENT actionGroupIds or actionRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to request forms with given record types
CompliancemandatoryThis method must be implemented.
MethodcreateActions
Description

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

Parametersosid.control.batch.ActionBatchFormListactionFormsthe action forms
Returnosid.transaction.batch.CreateResponseListthe create responses
ErrorsNULL_ARGUMENT actionForms is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActionFormsForUpdate
Description

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

Parametersosid.id.IdListactionIdsthe Ids of the Action
Returnosid.control.batch.ActionBatchFormListthe action form
ErrorsNOT_FOUNDa actionId is not found
NULL_ARGUMENT actionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateActions
Description

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

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

Deletes all Actions in this Control.

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

Deletes actions for the given Ids.

Parametersosid.id.IdListactionIdsthe Ids of the actions to delete
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT actionIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethoddeleteActionsForActionGroup
Description

Deletes actions for the given ActionGroup.

Parametersosid.id.IdactionGroupIdan action group Id
Returnosid.transaction.batch.DeleteResponseListthe delete responses
ErrorsNULL_ARGUMENT actionGroupId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaliasActions
Description

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