Interface | osid.rules.check.CheckEngineAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignChecks | ||
Description |
Tests if this user can alter hold/engine mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known instruction 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 | canAssignChecksToEngine | ||
Description |
Tests if this user can alter hold/engine mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known instruction 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 check can be assigned. | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.id.IdList | list of assignable engine Ids | |
Errors | NULL_ARGUMENT | engineId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableEngineIdsForCheck | ||
Description |
Gets a list of engines including and under the given engine node in which a specific check can be assigned. | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
osid.id.Id | checkId | the Id of the Check | |
Return | osid.id.IdList | list of assignable engine Ids | |
Errors | NULL_ARGUMENT | engineId or checkId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignCheckToEngine | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | checkId | the Id of the Check |
osid.id.Id | engineId | the Id of the Engine | |
Errors | ALREADY_EXISTS | checkId is already assigned to engineId | |
NOT_FOUND | checkId or engineId not found | ||
NULL_ARGUMENT | checkId or engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignCheckFromEngine | ||
Description |
Removes a | ||
Parameters | osid.id.Id | checkId | the Id of the Check |
osid.id.Id | engineId | the Id of the Engine | |
Errors | NOT_FOUND | checkId or engineId not found or
checkId not assigned to engineId | |
NULL_ARGUMENT | checkId or engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |