| Interface | osid.control.batch.ActionGroupBatchAdminSession | ||
|---|---|---|---|
| Implements | osid.control.ActionGroupAdminSession | ||
| Description | 
                 This session creates, updates, and deletes   Create and update operations differ in their usage. To 
                create an   The   Once a batch of   For updates,   Once a batch of   The delete operations delete   | ||
| Method | getActionGroupFormsForCreate | ||
| Description | 
                     Gets the action group forms for creating a bunch of new action groups.  | ||
| Parameters | cardinal | n | the number of forms to retrieve | 
osid.type.Type[] | actionGroupRecordTypes | array of action group record types to be included in each create operation or an empty list if none | |
| Return | osid.control.batch.ActionGroupBatchFormList | the action group forms | |
| Errors | NULL_ARGUMENT |  actionGroupRecordTypes  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 | createActionGroups | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.control.batch.ActionGroupBatchFormList | actionGroupForms | the action group forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  actionGroupForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getActionGroupFormsForUpdate | ||
| 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.  | ||
| Parameters | osid.id.IdList | actionGroupIds | the  Ids  of the  ActionGroup   | 
| Return | osid.control.batch.ActionGroupBatchFormList | the action group form | |
| Errors | NOT_FOUND | an  actionGroupId  is not found  |                 |
| NULL_ARGUMENT |  actionGroupIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateActionGroups | ||
| 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 
                      | ||
| Parameters | osid.control.batch.ActionGroupBatchFormList | actionGroupForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  actionGroupForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllActionGroups | ||
| 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 | deleteActionGroups | ||
| Description | 
                     Deletes action groups for the given   | ||
| Parameters | osid.id.IdList | actionGroupIds | the  Ids  of the action groups to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  actionGroupIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasActionGroups | ||
| 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. | |
| Method | getActionFormsForCreate | ||
| Description | 
                     Gets the action forms for creating a bunch of new actions. A form is retrieved for each action group.  | ||
| Parameters | osid.id.IdList | actionGroupIds | list of action groups | 
osid.type.Type[] | actionRecordTypes | array of action record types to be included in each create operation or an empty list if none | |
| Return | osid.control.batch.ActionBatchFormList | the action forms | |
| Errors | NOT_FOUND | an  actionGroupId  is not found  |                 |
| NULL_ARGUMENT |  actionGroupIds  or  actionRecordTypes  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 | createActions | ||
| Description | 
                     Creates a new set of   | ||
| Parameters | osid.control.batch.ActionBatchFormList | actionForms | the action forms | 
| Return | osid.transaction.batch.CreateResponseList | the create responses | |
| Errors | NULL_ARGUMENT |  actionForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getActionFormsForUpdate | ||
| Description | 
                     Gets the action forms for updating an existing set of actions. A new action form should be requested for each update transaction.  | ||
| Parameters | osid.id.IdList | actionIds | the  Ids  of the  Action   | 
| Return | osid.control.batch.ActionBatchFormList | the action form | |
| Errors | NOT_FOUND | a  actionId  is not found  |                 |
| NULL_ARGUMENT |  actionIds  is  null   |                 ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | updateActions | ||
| 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   | ||
| Parameters | osid.control.batch.ActionBatchFormList | actionForms | the form containing the elements to be updated | 
| Return | osid.transaction.batch.UpdateResponseList | the update responses | |
| Errors | NULL_ARGUMENT |  actionForms  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteAllActions | ||
| 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 | deleteActions | ||
| Description | 
                     Deletes actions for the given   | ||
| Parameters | osid.id.IdList | actionIds | the  Ids  of the actions to delete  | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  actionIds  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | deleteActionsForActionGroup | ||
| Description | 
                     Deletes actions for the given   | ||
| Parameters | osid.id.Id | actionGroupId | an action group  Id   | 
| Return | osid.transaction.batch.DeleteResponseList | the delete responses | |
| Errors | NULL_ARGUMENT |  actionGroupId  is  null   |                 |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | aliasActions | ||
| 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. | |