| Interface | osid.lexicon.ParameterPressSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.lexicon.LexiconManager | ||
osid.lexicon.LexiconProxyManager | |||
| Description |
This session provides methods to retrieve
This lookup session defines several views:
| ||
| Method | canLookupParameterPressMappings | ||
| Description |
Tests if this user can perform lookups of
parameter/press 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 | useComparativeParameterPressView | ||
| 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 | usePlenaryParameterPressView | ||
| Description |
A complete view of the | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getParameterIdsByPress | ||
| Description |
Gets the list of | ||
| Parameters | osid.id.Id | pressId | Id of the Press |
| Return | osid.id.IdList | list of related parameter Ids | |
| Errors | NOT_FOUND | pressId is not found | |
| NULL_ARGUMENT | pressId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getParametersByPress | ||
| Description |
Gets the list of parameters associated with a
| ||
| Parameters | osid.id.Id | pressId | Id of the Press |
| Return | osid.lexicon.ParameterList | list of related parameters | |
| Errors | NOT_FOUND | pressId is not found | |
| NULL_ARGUMENT | pressId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getParameterIdsByPresses | ||
| Description |
Gets the list of | ||
| Parameters | osid.id.IdList | pressIds | list of press Ids |
| Return | osid.id.IdList | list of parameter Ids | |
| Errors | NULL_ARGUMENT | pressIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getParametersByPresses | ||
| Description |
Gets the list of parameters corresponding to a list of
| ||
| Parameters | osid.id.IdList | pressIds | list of press Ids |
| Return | osid.lexicon.ParameterList | list of parameters | |
| Errors | NULL_ARGUMENT | pressIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getPressIdsByParameter | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | parameterId | Id of a Parameter |
| Return | osid.id.IdList | list of presses | |
| 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 | getPressesByParameter | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | parameterId | Id of a Parameter |
| Return | osid.lexicon.PressList | list of presses | |
| 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. | |