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.
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.
|
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
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
ActionGroupBatchFormList getActionGroupFormsForCreate(long n, Type[] actionGroupRecordTypes) throws OperationFailedException, PermissionDeniedException
n
- the number of forms to retrieveactionGroupRecordTypes
- array of action group record types to
be included in each create operation or an empty list if noneNullArgumentException
- actionGroupRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createActionGroups(ActionGroupBatchFormList actionGroupForms) throws OperationFailedException, PermissionDeniedException
ActionGroups.
This method returns
an error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateActionGroup
.actionGroupForms
- the action group formsNullArgumentException
- actionGroupForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActionGroupBatchFormList getActionGroupFormsForUpdate(IdList actionGroupIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
actionGroupIds
- the Ids
of the
ActionGroup
NotFoundException
- an actionGroupId
is
not foundNullArgumentException
- actionGroupIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateActionGroups(ActionGroupBatchFormList actionGroupForms) throws OperationFailedException, PermissionDeniedException
BatchCreateActionGroup
.actionGroupForms
- the form containing the elements to be
updatedNullArgumentException
- actionGroupForms
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllActionGroups() throws OperationFailedException, PermissionDeniedException
ActionGroups
in this System.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActionGroups(IdList actionGroupIds) throws OperationFailedException, PermissionDeniedException
Ids.
actionGroupIds
- the Ids
of the action groups to
deleteNullArgumentException
- actionGroupIds
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasActionGroups(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActionBatchFormList getActionFormsForCreate(IdList actionGroupIds, Type[] actionRecordTypes) throws NotFoundException, OperationFailedException, PermissionDeniedException
actionGroupIds
- list of action groupsactionRecordTypes
- array of action record types to be included
in each create operation or an empty list if noneNotFoundException
- an actionGroupId
is
not foundNullArgumentException
- actionGroupIds
or actionRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to request forms with
given record typesmandatory
- This method must be implemented. CreateResponseList createActions(ActionBatchFormList actionForms) throws OperationFailedException, PermissionDeniedException
Actions.
This method returns an
error if the entire operation fails. Otherwise, the status of an
individual create operation is indicated in the
BatchCreateAction
.actionForms
- the action formsNullArgumentException
- actionForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. ActionBatchFormList getActionFormsForUpdate(IdList actionIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
actionIds
- the Ids
of the Action
NotFoundException
- a actionId
is not
foundNullArgumentException
- actionIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. UpdateResponseList updateActions(ActionBatchFormList actionForms) throws OperationFailedException, PermissionDeniedException
BatchCreateAction
.actionForms
- the form containing the elements to be updatedNullArgumentException
- actionForms
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteAllActions() throws OperationFailedException, PermissionDeniedException
Actions
in this Control.
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActions(IdList actionIds) throws OperationFailedException, PermissionDeniedException
Ids.
actionIds
- the Ids
of the actions to deleteNullArgumentException
- actionIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DeleteResponseList deleteActionsForActionGroup(Id actionGroupId) throws OperationFailedException, PermissionDeniedException
ActionGroup.
actionGroupId
- an action group Id
NullArgumentException
- actionGroupId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. AliasResponseList aliasActions(AliasRequestList aliasRequests) throws OperationFailedException, PermissionDeniedException
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.
aliasRequests
- the alias requestsNullArgumentException
- aliasRequests
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.