Interface | osid.rules.RuleEngineAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignRules | ||
Description |
Tests if this user can alter rule/engine 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 | canAssignRulesToEngine | ||
Description |
Tests if this user can alter rule/engine 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 | engineId | the Id of the Engine |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | engineId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableEngineIds | ||
Description |
Gets a list of engines including and under the given engine node in which any rule can be assigned. | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.id.IdList | list of assignable rule Ids | |
Errors | NULL_ARGUMENT | engineId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableEngineIdsForRule | ||
Description |
Gets a list of engines including and under the given engine node in which a specific rule can be assigned. | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
osid.id.Id | ruleId | the Id of the Engine | |
Return | osid.id.IdList | list of assignable engine Ids | |
Errors | NULL_ARGUMENT | engineId or ruleId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignRuleToEngine | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | ruleId | the Id of the Rule |
osid.id.Id | engineId | the Id of the Engine | |
Errors | ALREADY_EXISTS | ruleId is already assigned to engineId | |
NOT_FOUND | ruleId or engineId not found | ||
NULL_ARGUMENT | ruleId or engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignRuleFromEngine | ||
Description |
Removes a | ||
Parameters | osid.id.Id | ruleId | the Id of the Rule |
osid.id.Id | engineId | the Id of the Engine | |
Errors | NOT_FOUND | ruleId or engineId not found or ruleId
not assigned to engineId | |
NULL_ARGUMENT | ruleId or engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignRuleToEngine | ||
Description |
Moves a | ||
Parameters | osid.id.Id | ruleId | the Id of the Rule |
osid.id.Id | fromEngineId | the Id of the current Engine | |
osid.id.Id | toEngineId | the Id of the destination Engine | |
Errors | NOT_FOUND | ruleId, fromEngineId, or toEngineId not found
or ruleId not mapped to fromEngineId | |
NULL_ARGUMENT | ruleId, fromEngineId, or toEngineId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |