Interface | osid.control.rules.InputEnablerRuleLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
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 | canLookupInputEnablerRules | ||
Description |
Tests if this user can perform lookups of input
enabler/input mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
Return | boolean | false if looking up mappings is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeInputEnablerRuleView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryInputEnablerRuleView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedSystemView | ||
Description |
Federates the view for methods in this session. A federated view will include input enablers in systems which are children of this system in the system hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedSystemView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this system only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getInputEnablerIdsForInput | ||
Description |
Gets the | ||
Parameters | osid.id.Id | inputId | Id of the Input |
Return | osid.id.IdList | the input enabler Ids | |
Errors | NOT_FOUND | inputId is not found | |
NULL_ARGUMENT | inputId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getInputEnablersForInput | ||
Description |
Gets the | ||
Parameters | osid.id.Id | inputId | Id of the Input |
Return | osid.control.rules.InputEnablerList | the input enablers | |
Errors | NOT_FOUND | inputId is not found | |
NULL_ARGUMENT | inputId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getInputIdsForInputEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | inputEnablerId | Id of an InputEnabler |
Return | osid.id.IdList | list of input Ids | |
Errors | NOT_FOUND | inputEnablerId is not found | |
NULL_ARGUMENT | inputEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getInputsForInputEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | inputEnablerId | Id of an InputEnabler |
Return | osid.control.InputList | list of inputs | |
Errors | NOT_FOUND | inputEnablerId is not found | |
NULL_ARGUMENT | inputEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |