Interface | osid.configuration.rules.ValueEnablerRuleLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | getConfigurationId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Configuration Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getConfiguration | ||
Description |
Gets the | ||
Return | osid.configuration.Configuration | the configuration | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupValueEnablerRules | ||
Description |
Tests if this user can perform lookups of value
enabler/value 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 | useComparativeValueEnablerRuleView | ||
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 | usePlenaryValueEnablerRuleView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedConfigurationView | ||
Description |
Federates the view for methods in this session. A federated view will include value enablers in configurations which are children of this configuration in the configuration hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedConfigurationView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this configuration only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getValueEnablerIdsForValue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | valueId | Id of the Value |
Return | osid.id.IdList | the value enabler Ids | |
Errors | NOT_FOUND | valueId is not found | |
NULL_ARGUMENT | valueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getValueEnablersForValue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | valueId | Id of the Value |
Return | osid.configuration.rules.ValueEnablerList | the value enablers | |
Errors | NOT_FOUND | valueId is not found | |
NULL_ARGUMENT | valueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getValueIdsForValueEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | valueEnablerId | Id of a ValueEnabler |
Return | osid.id.IdList | list of value Ids | |
Errors | NOT_FOUND | valueEnablerId is not found | |
NULL_ARGUMENT | valueEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getValuesForValueEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | valueEnablerId | Id of a ValueEnabler |
Return | osid.configuration.ValueList | list of values | |
Errors | NOT_FOUND | valueEnablerId is not found | |
NULL_ARGUMENT | valueEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |