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

This session provides methods for retrieving ParameterProcessors.

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated configuration view: All parameter processor methods in this session operate, retrieve and pertain to parameter processor defined explicitly in the current configuration. Using an isolated view is useful for managing ParameterProcessors with the ParameterProcessorAdminSession.
  • federated configuration view: All parameter processor 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.
  • active parameter processor view: All parameter processor lookup methods return active parameter processors.
  • any status parameter processor view: Parameter processors of any active or inactive status are returned from methods.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedDistributorView() and useIsolatedDistributorView() behave as a radio group and one should be selected before invoking the methods in this session.

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.
MethodcanLookupParameterProcessors
Description

Tests if this user can perform ParameterProcessors lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeParameterProcessorView
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.
MethodusePlenaryParameterProcessorView
Description

A complete view of the 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 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.
MethoduseActiveParameterProcessorView
Description

Only active parameter processors are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusParameterProcessorView
Description

All active and inactive parameter processors are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethodgetParameterProcessor
Description

Gets the ParameterProcessor specified by its Id.

In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned ParameterProcessor may have a different Id than requested, such as the case where a duplicate Id was assigned to a ParameterProcessor and retained for compatibility.

In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned.

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

Gets a ParameterProcessorList corresponding to the given IdList.

In plenary mode, the returned list contains all of the parameter processor specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible ParameterProcessors may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned.

Parametersosid.id.IdListparameterProcessorIdsthe list of Ids to retrieve
Returnosid.configuration.rules.ParameterProcessorListthe returned ParameterProcessor list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT parameterProcessorIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorsByGenusType
Description

Gets a ParameterProcessorList corresponding to the given parameter processor genus Type which does not include parameter processor of genus types derived from the specified Type.

In plenary mode, the returned list contains all known parameter processor or an error results. Otherwise, the returned list may contain only those parameter processor that are accessible through this session.

In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned.

Parametersosid.type.TypeparameterProcessorGenusTypea parameter processor genus type
Returnosid.configuration.rules.ParameterProcessorListthe returned ParameterProcessor list
ErrorsNULL_ARGUMENT parameterProcessorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorsByParentGenusType
Description

Gets a ParameterProcessorList corresponding to the given parameter processor genus Type and include any additional parameter processor with genus types derived from the specified Type.

In plenary mode, the returned list contains all known parameter processor or an error results. Otherwise, the returned list may contain only those parameter processor that are accessible through this session.

In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned.

Parametersosid.type.TypeparameterProcessorGenusTypea parameter processor genus type
Returnosid.configuration.rules.ParameterProcessorListthe returned ParameterProcessor list
ErrorsNULL_ARGUMENT parameterProcessorGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessorsByRecordType
Description

Gets a ParameterProcessorList containing the given parameter processor record Type.

In plenary mode, the returned list contains all known parameter processor or an error results. Otherwise, the returned list may contain only those parameter processor that are accessible through this session.

In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned.

Parametersosid.type.TypeparameterProcessorRecordTypea parameter processor record type
Returnosid.configuration.rules.ParameterProcessorListthe returned ParameterProcessor list
ErrorsNULL_ARGUMENT parameterProcessorRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetParameterProcessors
Description

Gets all ParameterProcessors.

In plenary mode, the returned list contains all known parameter processor or an error results. Otherwise, the returned list may contain only those parameter processor that are accessible through this session.

In active mode, parameter processors are returned that are currently active. In any status mode, active and inactive parameter processors are returned.

Returnosid.configuration.rules.ParameterProcessorListthe returned ParameterProcessor list
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.