Interface | osid.configuration.ParameterConfigurationSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for accessing the
configurations of a parameter. A This lookup session defines two views:
| ||
Method | canLookupParameterConfigurations | ||
Description |
Tests if this user can perform lookups on
configurations of parameters. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known all methods in this session
will result in a | ||
Return | boolean | false if lookups are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeParameterView | ||
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 | usePlenaryParameterView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getParameterIdsByConfiguration | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | configurationId | Id of the Configuration |
Return | osid.id.IdList | list of matching parameter 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 | getParametersByConfiguration | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | configurationId | Id of the Configuration |
Return | osid.configuration.ParameterList | list of matching parameters | |
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 | getParameterIdsByConfigurations | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | configurationIds | list of configurations |
Return | osid.id.IdList | list of parameter 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 | getParametersByConfigurations | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | configurationIds | list of configurations |
Return | osid.configuration.ParameterList | list of parameters | |
Errors | NULL_ARGUMENT | configurationIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationIdsByParameter | ||
Description |
Gets the | ||
Parameters | osid.id.Id | parameterId | Id of a Parameter |
Return | osid.id.IdList | list of configuration Ids | |
Errors | NOT_FOUND | parameterId is not found | |
NULL_ARGUMENT | parameterId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getConfigurationsByParameter | ||
Description |
Gets the | ||
Parameters | osid.id.Id | parameterId | Id of a Parameter |
Return | osid.configuration.ConfigurationList | list of configurations | |
Errors | NOT_FOUND | parameterId is not found | |
NULL_ARGUMENT | parameterId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |