Interface | osid.configuration.rules.ParameterProcessorEnablerConfigurationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupParameterProcessorEnablerConfigurationMappings | ||
Description |
Tests if this user can perform lookups of parameter
processor 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 | useComparativeParameterProcessorEnablerConfigurationView | ||
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 | usePlenaryParameterProcessorEnablerConfigurationView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getParameterProcessorEnablerIdsByConfiguration | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | configurationId | Id of the Configuration |
Return | osid.id.IdList | list of related parameter processor 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 | getParameterProcessorEnablersByConfiguration | ||
Description |
Gets the list of parameter processor enablers
associated with an | ||
Parameters | osid.id.Id | configurationId | Id of the Configuration |
Return | osid.configuration.rules.ParameterProcessorEnablerList | list of related parameter processor 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 | getParameterProcessorEnablerIdsByConfigurations | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | configurationIds | list of configuration Ids |
Return | osid.id.IdList | list of parameter processor 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 | getParameterProcessorEnablersByConfigurations | ||
Description |
Gets the list of parameter processor enablers
corresponding to a list of | ||
Parameters | osid.id.IdList | configurationIds | list of configuration Ids |
Return | osid.configuration.rules.ParameterProcessorEnablerList | list of parameter processor 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 | getConfigurationIdsByParameterProcessorEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | parameterProcessorEnablerId | Id of a ParameterProcessorEnabler |
Return | osid.id.IdList | list of configurations | |
Errors | NOT_FOUND | parameterProcessorEnablerId is not found | |
NULL_ARGUMENT | parameterProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationsByParameterProcessorEnabler | ||
Description |
Gets the | ||
Parameters | osid.id.Id | parameterProcessorEnablerId | Id of a ParameterProcessorEnabler |
Return | osid.configuration.ConfigurationList | list of configurations | |
Errors | NOT_FOUND | parameterProcessorEnablerId is not found | |
NULL_ARGUMENT | parameterProcessorEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |