org.osid.control.batch

Interface ActionGroupBatchAdminSession

All Superinterfaces:

ActionGroupAdminSession, java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ActionGroupBatchAdminSession
extends ActionGroupAdminSession

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.

Method Summary

Methods

Modifier and Type	Method and Description
AliasResponseList	aliasActionGroups(AliasRequestList aliasRequests) Adds an Id to an ActionGroup for the purpose of creating compatibility.
AliasResponseList	aliasActions(AliasRequestList aliasRequests) Adds an Id to a Action for the purpose of creating compatibility.
CreateResponseList	createActionGroups(ActionGroupBatchFormList actionGroupForms) Creates a new set of ActionGroups.
CreateResponseList	createActions(ActionBatchFormList actionForms) Creates a new set of Actions.
DeleteResponseList	deleteActionGroups(IdList actionGroupIds) Deletes action groups for the given Ids.
DeleteResponseList	deleteActions(IdList actionIds) Deletes actions for the given Ids.
DeleteResponseList	deleteActionsForActionGroup(Id actionGroupId) Deletes actions for the given ActionGroup.
DeleteResponseList	deleteAllActionGroups() Deletes all ActionGroups in this System.
DeleteResponseList	deleteAllActions() Deletes all Actions in this Control.
ActionBatchFormList	getActionFormsForCreate(IdList actionGroupIds, Type[] actionRecordTypes) Gets the action forms for creating a bunch of new actions.
ActionBatchFormList	getActionFormsForUpdate(IdList actionIds) Gets the action forms for updating an existing set of actions.
ActionGroupBatchFormList	getActionGroupFormsForCreate(long n, Type[] actionGroupRecordTypes) Gets the action group forms for creating a bunch of new action groups.
ActionGroupBatchFormList	getActionGroupFormsForUpdate(IdList actionGroupIds) Gets the action group forms for updating an existing set of action groups.
UpdateResponseList	updateActionGroups(ActionGroupBatchFormList actionGroupForms) Updates existing action groups.
UpdateResponseList	updateActions(ActionBatchFormList actionForms) Updates existing actions.

Methods inherited from interface org.osid.control.ActionGroupAdminSession

aliasAction, aliasActionGroup, canCreateActionGroups, canCreateActionGroupWithRecordTypes, canCreateActionWithRecordTypes, canDeleteActionGroups, canDeleteActions, canManageActionAliases, canManageActionGroupAliases, canSequenceActions, canUpdateActionGroups, canUpdateActions, createAction, createActionGroup, deleteAction, deleteActionGroup, getActionFormForCreate, getActionFormForUpdate, getActionGroupFormForCreate, getActionGroupFormForUpdate, getSystem, getSystemId, moveActionAhead, moveActionBehind, orderActions, updateAction, updateActionGroup

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getActionGroupFormsForCreate

ActionGroupBatchFormList getActionGroupFormsForCreate(long n,
                                                    Type[] actionGroupRecordTypes)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

n - the number of forms to retrieve

actionGroupRecordTypes - array of action group record types to be included in each create operation or an empty list if none

Returns:

the action group forms

Throws:

NullArgumentException - actionGroupRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createActionGroups

CreateResponseList createActionGroups(ActionGroupBatchFormList actionGroupForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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 .

Parameters:

actionGroupForms - the action group forms

Returns:

the create responses

Throws:

NullArgumentException - actionGroupForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionGroupFormsForUpdate

ActionGroupBatchFormList getActionGroupFormsForUpdate(IdList actionGroupIds)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

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.

Parameters:

actionGroupIds - the Ids of the ActionGroup

Returns:

the action group form

Throws:

NotFoundException - an actionGroupId is not found

NullArgumentException - actionGroupIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateActionGroups

UpdateResponseList updateActionGroups(ActionGroupBatchFormList actionGroupForms)
                                      throws OperationFailedException,
                                             PermissionDeniedException

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 .

Parameters:

actionGroupForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - actionGroupForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllActionGroups

DeleteResponseList deleteAllActionGroups()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Deletes all ActionGroups in this System.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteActionGroups

DeleteResponseList deleteActionGroups(IdList actionGroupIds)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Deletes action groups for the given Ids.

Parameters:

actionGroupIds - the Ids of the action groups to delete

Returns:

the delete responses

Throws:

NullArgumentException - actionGroupIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasActionGroups

AliasResponseList aliasActionGroups(AliasRequestList aliasRequests)
                                    throws OperationFailedException,
                                           PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionFormsForCreate

ActionBatchFormList getActionFormsForCreate(IdList actionGroupIds,
                                          Type[] actionRecordTypes)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

actionGroupIds - list of action groups

actionRecordTypes - array of action record types to be included in each create operation or an empty list if none

Returns:

the action forms

Throws:

NotFoundException - an actionGroupId is not found

NullArgumentException - actionGroupIds or actionRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to request forms with given record types

Compliance:

mandatory - This method must be implemented.

createActions

CreateResponseList createActions(ActionBatchFormList actionForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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 .

Parameters:

actionForms - the action forms

Returns:

the create responses

Throws:

NullArgumentException - actionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getActionFormsForUpdate

ActionBatchFormList getActionFormsForUpdate(IdList actionIds)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

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

Parameters:

actionIds - the Ids of the Action

Returns:

the action form

Throws:

NotFoundException - a actionId is not found

NullArgumentException - actionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateActions

UpdateResponseList updateActions(ActionBatchFormList actionForms)
                                 throws OperationFailedException,
                                        PermissionDeniedException

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 .

Parameters:

actionForms - the form containing the elements to be updated

Returns:

the update responses

Throws:

NullArgumentException - actionForms is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteAllActions

DeleteResponseList deleteAllActions()
                                    throws OperationFailedException,
                                           PermissionDeniedException

Deletes all Actions in this Control.

Returns:

the delete responses

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteActions

DeleteResponseList deleteActions(IdList actionIds)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Deletes actions for the given Ids.

Parameters:

actionIds - the Ids of the actions to delete

Returns:

the delete responses

Throws:

NullArgumentException - actionIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

deleteActionsForActionGroup

DeleteResponseList deleteActionsForActionGroup(Id actionGroupId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Deletes actions for the given ActionGroup.

Parameters:

actionGroupId - an action group Id

Returns:

the delete responses

Throws:

NullArgumentException - actionGroupId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

aliasActions

AliasResponseList aliasActions(AliasRequestList aliasRequests)
                               throws OperationFailedException,
                                      PermissionDeniedException

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.

Parameters:

aliasRequests - the alias requests

Returns:

the alias responses

Throws:

NullArgumentException - aliasRequests is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.