Interface | osid.control.rules.ActionEnablerSystemAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of an | ||
Method | canAssignActionEnablers | ||
Description |
Tests if this user can alter action enabler/system
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignActionEnablersToSystem | ||
Description |
Tests if this user can alter action enabler/system
mappings. A return of true does not guarantee successful
authorization. A return of false indicates that it is
known mapping methods in this session will result in a
| ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | systemId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableSystemIds | ||
Description |
Gets a list of systems including and under the given system node in which any action enabler can be assigned. | ||
Parameters | osid.id.Id | systemId | the Id of the System |
Return | osid.id.IdList | list of assignable system Ids | |
Errors | NULL_ARGUMENT | systemId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableSystemIdsForActionEnabler | ||
Description |
Gets a list of systems including and under the given system node in which a specific action enabler can be assigned. | ||
Parameters | osid.id.Id | systemId | the Id of the System |
osid.id.Id | actionEnablerId | the Id of the ActionEnabler | |
Return | osid.id.IdList | list of assignable system Ids | |
Errors | NULL_ARGUMENT | systemId or actionEnablerId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignActionEnablerToSystem | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | actionEnablerId | the Id of the ActionEnabler |
osid.id.Id | systemId | the Id of the System | |
Errors | ALREADY_EXISTS | actionEnablerId already assigned to systemId | |
NOT_FOUND | actionEnablerId or systemId not found | ||
NULL_ARGUMENT | actionEnablerId or systemId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignActionEnablerFromSystem | ||
Description |
Removes an | ||
Parameters | osid.id.Id | actionEnablerId | the Id of the ActionEnabler |
osid.id.Id | systemId | the Id of the System | |
Errors | NOT_FOUND | actionEnablerId or systemId not found or
actionEnablerId already assigned to systemId | |
NULL_ARGUMENT | actionEnablerId or systemId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignActionEnablerToSystem | ||
Description |
Moves an | ||
Parameters | osid.id.Id | actionEnablerId | the Id of the ActionEnabler |
osid.id.Id | fromSystemId | the Id of the current System | |
osid.id.Id | toSystemId | the Id of the destination System | |
Errors | NOT_FOUND | actionEnablerId, fromSystemId, or toSystemId
not found or actionEnablerId not mapped to fromSystemId
| |
NULL_ARGUMENT | actionEnablerId, fromSystemId, or toSystemId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |