OSID Logo
OSID Specifications
configuration rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.rules.ParameterProcessorRuleLookupSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve ParameterProcessor to Parameter mappings.

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
  • isolated configuration view: All methods in this session operate, retrieve and pertain parameter processor defined explicitly in the current configuration
  • federated configuration view: All methods in this session operate, retrieve and pertain to all parameter processor defined in this configuration and any other parameter processor implicitly available in this configuration through configuration inheritence.
MethodgetConfigurationId
Description

Gets the Configuration Id associated with this session.

Returnosid.id.Idthe Configuration Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetConfiguration
Description

Gets the Configuration associated with this session.

Returnosid.configuration.Configurationthe configuration
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupParameterProcessorRules
Description

Tests if this user can perform lookups of parameter processor/parameter 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 application that may opt not to offer lookup operations to unauthorized users.

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

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryParameterProcessorRuleView
Description

A complete view of the ParameterProcessor and Parameter 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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedConfigurationView
Description

Federates the view for methods in this session. A federated view will include parameter processor in configurations which are children of this configuration in the configuration hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedConfigurationView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this configuration only.

CompliancemandatoryThis method is must be implemented.
MethodgetParameterProcessorIdsForParameter
Description

Gets the ParameterProcessor Id associated with a Parameter.

Parametersosid.id.IdparameterId Id of the Parameter
Returnosid.id.IdListthe parameter processor Ids
ErrorsNOT_FOUND parameterId is not found
NULL_ARGUMENT parameterId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorsForParameter
Description

Gets the ParameterProcessor associated with a Parameter.

Parametersosid.id.IdparameterId Id of the Parameter
Returnosid.configuration.rules.ParameterProcessorListthe parameter processors
ErrorsNOT_FOUND parameterId is not found
NULL_ARGUMENT parameterId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterIdsForParameterProcessor
Description

Gets the Parameter Ids mapped to an ParameterProcessor.

Parametersosid.id.IdparameterProcessorId Id of an ParameterProcessor
Returnosid.id.IdListlist of parameter Ids
ErrorsNOT_FOUND parameterProcessorId is not found
NULL_ARGUMENT parameterProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParametersForParameterProcessor
Description

Gets the Parameters mapped to an ParameterProcessor.

Parametersosid.id.IdparameterProcessorId Id of an ParameterProcessor
Returnosid.configuration.ParameterListlist of parameters
ErrorsNOT_FOUND parameterProcessorId is not found
NULL_ARGUMENT parameterProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.