Interface | osid.control.ActionGroupAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | getSystemId | ||
Description |
Gets the | ||
Return | osid.id.Id | the System Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystem | ||
Description |
Gets the | ||
Return | osid.control.System | the system | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateActionGroups | ||
Description |
Tests if this user can create | ||
Return | boolean | false if ActionGroup creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateActionGroupWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | actionGroupRecordTypes | array of action group record types |
Return | boolean | true if ActionGroup creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | actionGroupRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupFormForCreate | ||
Description |
Gets the action group form for creating new action groups. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | actionGroupRecordTypes | array of action group record types |
Return | osid.control.ActionGroupForm | the action group form | |
Errors | NULL_ARGUMENT | actionGroupRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createActionGroup | ||
Description |
Creates a new | ||
Parameters | osid.control.ActionGroupForm | actionGroupForm | the form for this ActionGroup |
Return | osid.control.ActionGroup | the new ActionGroup | |
Errors | ILLEGAL_STATE | actionGroupForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | actionGroupForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | actionGroupForm did not originate from
getActionGroupFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateActionGroups | ||
Description |
Tests if this user can update | ||
Return | boolean | false if ActionGroup modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionGroupFormForUpdate | ||
Description |
Gets the action group form for updating an existing action group. A new action group form should be requested for each update transaction. | ||
Parameters | osid.id.Id | actionGroupId | the Id of the ActionGroup |
Return | osid.control.ActionGroupForm | the action group form | |
Errors | NOT_FOUND | actionGroupId is not found | |
NULL_ARGUMENT | actionGroupId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateActionGroup | ||
Description |
Updates an existing action group. | ||
Parameters | osid.control.ActionGroupForm | actionGroupForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | actionGroupForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | actionGroupForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | actionGroupForm did not originate from
getActionGroupFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteActionGroups | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if ActionGroup deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteActionGroup | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | actionGroupId | the Id of the ActionGroup to remove |
Errors | NOT_FOUND | actionGroupId not found | |
NULL_ARGUMENT | actionGroupId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageActionGroupAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if ActionGroup aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasActionGroup | ||
Description |
Adds an | ||
Parameters | osid.id.Id | actionGroupId | the Id of an ActionGroup |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | actionGroupId not found | ||
NULL_ARGUMENT | actionGroupId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateActionWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | actionRecordTypes | array of action record types |
Return | boolean | true if Action creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | actionRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionFormForCreate | ||
Description |
Gets the action form for creating new actions. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | actionGroupId | an action group Id |
osid.type.Type[] | actionRecordTypes | array of action record types | |
Return | osid.control.ActionForm | the action form | |
Errors | NOT_FOUND | actionGroupId is not found | |
NULL_ARGUMENT | actionGroupId or actionRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createAction | ||
Description |
Creates a new | ||
Parameters | osid.control.ActionForm | actionForm | the form for this Action |
Return | osid.control.Action | the new Action | |
Errors | ILLEGAL_STATE | actionForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | actionForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | actionForm did not originate from
getActionFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateActions | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Action modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionFormForUpdate | ||
Description |
Gets the action form for updating an existing action. A new action form should be requested for each update transaction. | ||
Parameters | osid.id.Id | actionId | the Id of the Action |
Return | osid.control.ActionForm | the action form | |
Errors | NOT_FOUND | actionId is not found | |
NULL_ARGUMENT | actionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateAction | ||
Description |
Updates an existing action. | ||
Parameters | osid.control.ActionForm | actionForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | actionForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | actionForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | actionForm did not originate from
getActionFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteActions | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Action deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteAction | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | actionId | the Id of the Action to remove |
Errors | NOT_FOUND | actionId not found | |
NULL_ARGUMENT | actionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageActionAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Action aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasAction | ||
Description |
Adds an | ||
Parameters | osid.id.Id | actionId | the Id of an Action |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | actionId not found | ||
NULL_ARGUMENT | actionId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceActions | ||
Description |
Tests if this user can order | ||
Return | boolean | false if Action ordering is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveActionAhead | ||
Description |
Reorders actions in an action grpup by moving the specified action in front of a reference action. | ||
Parameters | osid.id.Id | actionId | the Id of an Action |
osid.id.Id | actionGroupId | the Id of an ActionGroup | |
osid.id.Id | referenceId | the reference action Id | |
Errors | NOT_FOUND | actionId, actionGroupId, or referenceId not
found or, actionId or referenceId not related to
actionGroupId | |
NULL_ARGUMENT | actionId, actionGroupId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveActionBehind | ||
Description |
Reorders actions in an action group by moving the specified action behind a reference action. | ||
Parameters | osid.id.Id | actionId | the Id of an Action |
osid.id.Id | actionGroupId | the Id of an ActionGroup | |
osid.id.Id | referenceId | the reference action Id | |
Errors | NOT_FOUND | actionId, actionGroupId, or referenceId not
found or, actionId or referenceId not related to
actionGroupId | |
NULL_ARGUMENT | actionId, actionGroupId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderActions | ||
Description |
Reorders a set of actions in an action group. | ||
Parameters | osid.id.Id[] | actionIds | the Ids for a set of Actiond |
osid.id.Id | actionGroupId | the Id of an ActionGroup | |
Errors | NOT_FOUND | actionGroupId not found or, an actionId not
related to actionGroupId | |
NULL_ARGUMENT | actionIds or actionGroupId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |