OSID Logo
OSID Specifications
lexicon package
Version 3.1.0
Interfaceosid.lexicon.ParameterPressSession
Implementsosid.OsidSession
Used Byosid.lexicon.LexiconManager
osid.lexicon.LexiconProxyManager
Description

This session provides methods to retrieve Parameter to Press mappings. A Parameter may appear in multiple Press objects. Each press may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupParameterPressMappings
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 PERMISSION_DENIED. This is intended as a hint to an press that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethoduseComparativeParameterPressView
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.

Compliancemandatory This method is must be implemented.
MethodusePlenaryParameterPressView
Description

A complete view of the Parameter and Press returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliancemandatory This method is must be implemented.
MethodgetParameterIdsByPress
Description

Gets the list of Parameter Ids associated with a Press.

Parametersosid.id.IdpressId Id of the Press
Returnosid.id.IdList list of related parameter Ids
ErrorsNOT_FOUND pressId is not found
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetParametersByPress
Description

Gets the list of parameters associated with a Press.

Parametersosid.id.IdpressId Id of the Press
Returnosid.lexicon.ParameterList list of related parameters
ErrorsNOT_FOUND pressId is not found
NULL_ARGUMENT pressId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetParameterIdsByPresses
Description

Gets the list of Parameter Ids corresponding to a list of Presses.

Parametersosid.id.IdListpressIds list of press Ids
Returnosid.id.IdList list of parameter Ids
ErrorsNULL_ARGUMENT pressIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetParametersByPresses
Description

Gets the list of parameters corresponding to a list of Presses.

Parametersosid.id.IdListpressIds list of press Ids
Returnosid.lexicon.ParameterList list of parameters
ErrorsNULL_ARGUMENT pressIds is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetPressIdsByParameter
Description

Gets the Press Ids mapped to a Parameter.

Parametersosid.id.IdparameterId Id of a Parameter
Returnosid.id.IdList list of presses
ErrorsNOT_FOUND parameterId is not found
NULL_ARGUMENT parameterId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodgetPressesByParameter
Description

Gets the Presses mapped to a Parameter.

Parametersosid.id.IdparameterId Id of a Parameter
Returnosid.lexicon.PressList list of presses
ErrorsNOT_FOUND parameterId is not found
NULL_ARGUMENT parameterId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.