Interface | osid.control.rules.ActionEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes action enablers. The data
for create and update is provided via the | ||
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 | canCreateActionEnabler | ||
Description |
Tests if this user can create action enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known creating an
| ||
Return | boolean | false if ActionEnabler creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateActionEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | actionEnablerRecordTypes | array of action enabler record types |
Return | boolean | true if ActionEnabler creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | actionEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionEnablerFormForCreate | ||
Description |
Gets the action enabler form for creating new action enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | actionEnablerRecordTypes | array of action enabler record types |
Return | osid.control.rules.ActionEnablerForm | the action enabler form | |
Errors | NULL_ARGUMENT | actionEnablerRecordTypes 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 | createActionEnabler | ||
Description |
Creates a new | ||
Parameters | osid.control.rules.ActionEnablerForm | actionEnablerForm | the form for this ActionEnabler |
Return | osid.control.rules.ActionEnabler | the new ActionEnabler | |
Errors | ILLEGAL_STATE | actionEnablerForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | actionEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | actionEnablerForm did not originate from
getActionEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateActionEnablers | ||
Description |
Tests if this user can update action enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known updating an
| ||
Return | boolean | false if ActionEnabler modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActionEnablerFormForUpdate | ||
Description |
Gets the action enabler form for updating an existing action enabler. A new action enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | actionEnablerId | the Id of the ActionEnabler |
Return | osid.control.rules.ActionEnablerForm | the action enabler form | |
Errors | NOT_FOUND | actionEnablerId is not found | |
NULL_ARGUMENT | actionEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateActionEnabler | ||
Description |
Updates an existing action enabler. | ||
Parameters | osid.control.rules.ActionEnablerForm | actionEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | actionEnablerForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | actionEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | actionEnablerForm did not originate from
getActionEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteActionEnablers | ||
Description |
Tests if this user can delete action enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known deleting an
| ||
Return | boolean | false if ActionEnabler deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteActionEnabler | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | actionEnablerId | the Id of the ActionEnabler to remove |
Errors | NOT_FOUND | actionEnablerId not found | |
NULL_ARGUMENT | actionEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageActionEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if ActionEnabler aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasActionEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | actionEnablerId | the Id of an ActionEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | actionEnablerId not found | ||
NULL_ARGUMENT | actionEnablerId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |