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

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

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

Tests if this user can alter parameter processor enabler/parameter processor mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodassignParameterProcessorEnablerToParameterProcessor
Description

Adds an existing ParameterProcessorEnabler to a ParameterProcessor.

Parametersosid.id.IdparameterProcessorEnablerIdthe Id of the ParameterProcessorEnabler
osid.id.IdparameterProcessorIdthe Id of the ParameterProcessor
ErrorsALREADY_EXISTS parameterProcessorEnablerId is already applied to parameterProcessorId
NOT_FOUND parameterProcessorEnablerId or parameterProcessorId not found
NULL_ARGUMENT parameterProcessorEnablerId or parameterProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignParameterProcessorEnablerFromParameterProcessor
Description

Removes a ParameterProcessorEnabler from a ParameterProcessor.

Parametersosid.id.IdparameterProcessorEnablerIdthe Id of the ParameterProcessorEnabler
osid.id.IdparameterProcessorIdthe Id of the ParameterProcessor
ErrorsNOT_FOUND parameterProcessorEnablerId or parameterProcessorId not found or parameterProcessorEnablerId is not applied to parameterProcessorId
NULL_ARGUMENT parameterProcessorEnablerId or parameterProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceParameterProcessorEnablers
Description

Tests if this user can order ParametereProcessorEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if ParameterProcessorEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveParameterProcessorEnablerAhead
Description

Reorders parameter processor enablers for a parameter processor by moving the specified parameter processor enabler in front of a reference parameter enabler.

Parametersosid.id.IdparameterProcessorEnablerIdthe Id of a ParameterProcessorEnabler
osid.id.IdparameterEnablerIdthe Id of a ParameterProcessor
osid.id.IdreferenceIdthe reference parameter processor enabler Id
ErrorsNOT_FOUND parameterProcessorEnablerId, parameterEnablerId, or referenceId not found or, parameterProcessorEnablerId, or referenceId not related to parameterEnablerId
NULL_ARGUMENT parameterProcessorEnablerId, parameterEnablerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveParameterProcessorEnablerBehind
Description

Reorders parameter processor enablers for a parameter by moving the specified parameter processor enabler behind a reference parameter processor enabler.

Parametersosid.id.IdparameterProcessorEnablerIdthe Id of a ParameterProcessorEnabler
osid.id.IdparameterEnablerIdthe Id of a ParameterProcessor
osid.id.IdreferenceIdthe reference parameter processor enabler Id
ErrorsNOT_FOUND parameterProcessorEnablerId, parameterEnablerId, or referenceId not found or, parameterProcessorEnablerId, or referenceId not related to parameterEnablerId
NULL_ARGUMENT parameterProcessorEnablerId, parameterEnablerId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderParameterProcessorEnablers
Description

Reorders a set of parameter processor enablers for a parameter processor.

Parametersosid.id.Id[]parameterProcessorEnablerIdsthe Ids for a set of ParameterProcessorEnablers
osid.id.IdparameterProcessorIdthe Id of a ParameterProcessor
ErrorsNOT_FOUND parameterProcessorId not found or, a parameterProcessorEnablerId not related to parameterProcessorId
NULL_ARGUMENT parameterProcessorEnablerIds or parameterProcessorId, is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.