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

This session provides methods to retrieve ParameterProcessorEnabler to Configuration mappings. A ParameterProcessorEnabler may appear in multiple Configuration objects. Each configuration 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
MethodcanLookupParameterProcessorEnablerConfigurationMappings
Description

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

A complete view of the ParameterProcessorEnabler and Configuration 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.
MethodgetParameterProcessorEnablerIdsByConfiguration
Description

Gets the list of ParameterProcessorEnablerIds associated with an Configuration.

Parametersosid.id.IdconfigurationId Id of the Configuration
Returnosid.id.IdListlist of related parameter processor enabler Ids
ErrorsNOT_FOUND configurationId is not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorEnablersByConfiguration
Description

Gets the list of parameter processor enablers associated with an Configuration.

Parametersosid.id.IdconfigurationId Id of the Configuration
Returnosid.configuration.rules.ParameterProcessorEnablerListlist of related parameter processor enablers
ErrorsNOT_FOUND configurationId is not found
NULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorEnablerIdsByConfigurations
Description

Gets the list of ParameterProcessorEnabler Ids corresponding to a list of Configurations.

Parametersosid.id.IdListconfigurationIdslist of configuration Ids
Returnosid.id.IdListlist of parameter processor enabler Ids
ErrorsNULL_ARGUMENT configurationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorEnablersByConfigurations
Description

Gets the list of parameter processor enablers corresponding to a list of Configurations.

Parametersosid.id.IdListconfigurationIdslist of configuration Ids
Returnosid.configuration.rules.ParameterProcessorEnablerListlist of parameter processor enablers
ErrorsNULL_ARGUMENT configurationIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetConfigurationIdsByParameterProcessorEnabler
Description

Gets the Configuration Ids mapped to a ParameterProcessorEnabler.

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

Gets the Configurations mapped to a ParameterProcessorEnabler.

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