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

This session provides methods to retrieve ParameterProcessorEnabler to ParameterProcessor mappings. A ParameterProcessor with multiple ParameterProcessorEnablers means any positive rule evaluation across the enablers result in an effective ParameterProcessor.

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

Tests if this user can perform lookups of parameter processor enabler/parameter processor 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.
MethoduseComparativeParameterProcessorEnablerRuleView
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.
MethodusePlenaryParameterProcessorEnablerRuleView
Description

A complete view of the ParameterProcessorEnabler and ParameterProcessor 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 enablers 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.
MethodgetParameterProcessorEnablerIdsForParameterProcessor
Description

Gets the ParameterProcessorEnabler Id associated with a ParameterProcessor.

Parametersosid.id.IdparameterProcessorId Id of the ParameterProcessor
Returnosid.id.IdListthe parameter processor enabler 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.
MethodgetParameterProcessorEnablersForParameterProcessor
Description

Gets the ParameterProcessorEnabler associated with a ParameterProcessor.

Parametersosid.id.IdparameterProcessorId Id of the ParameterProcessor
Returnosid.configuration.rules.ParameterProcessorEnablerListthe parameter processor enablers
ErrorsNOT_FOUND parameterProcessorId is not found
NULL_ARGUMENT parameterProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorIdsForParameterProcessorEnabler
Description

Gets the ParameterProcessor Ids mapped to a ParameterProcessorEnabler.

Parametersosid.id.IdparameterProcessorEnablerId Id of a ParameterProcessorEnabler
Returnosid.id.IdListlist of parameter processor Ids
ErrorsNOT_FOUND parameterProcessorEnablerId is not found
NULL_ARGUMENT parameterProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorsForParameterProcessorEnabler
Description

Gets the ParameterProcessors mapped to a ParameterProcessorEnabler.

Parametersosid.id.IdparameterProcessorEnablerId Id of a ParameterProcessorEnabler
Returnosid.configuration.rules.ParameterProcessorListlist of parameter processors
ErrorsNOT_FOUND parameterProcessorEnablerId is not found
NULL_ARGUMENT parameterProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.