Interface | osid.configuration.rules.ValueEnablerConfigurationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupValueEnablerConfigurationMappings | ||
Description |
Tests if this user can perform lookups of value
enabler/configuration 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 | useComparativeValueEnablerConfigurationView | ||
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 | usePlenaryValueEnablerConfigurationView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getValueEnablerIdsByConfiguration | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | configurationId | Id of the Configuration |
Return | osid.id.IdList | list of related value enabler Ids | |
Errors | NOT_FOUND | configurationId is not found | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getValueEnablersByConfiguration | ||
Description |
Gets the list of value enablers associated with an
| ||
Parameters | osid.id.Id | configurationId | Id of the Configuration |
Return | osid.configuration.rules.ValueEnablerList | list of related value enablers | |
Errors | NOT_FOUND | configurationId is not found | |
NULL_ARGUMENT | configurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getValueEnablerIdsByConfigurations | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | configurationIds | list of configuration Ids |
Return | osid.id.IdList | list of value enabler Ids | |
Errors | NULL_ARGUMENT | configurationIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getValueEnablersByConfigurations | ||
Description |
Gets the list of value enablers corresponding to a list
of | ||
Parameters | osid.id.IdList | configurationIds | list of configuration Ids |
Return | osid.configuration.rules.ValueEnablerList | list of value enablers | |
Errors | NULL_ARGUMENT | configurationIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationIdsByValueEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | valueEnablerId | Id of a ValueEnabler |
Return | osid.id.IdList | list of configurations | |
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 | getConfigurationsByValueEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | valueEnablerId | Id of a ValueEnabler |
Return | osid.configuration.ConfigurationList | list of configurations | |
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. |