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

This session provides methods to apply ValueEnablers to Values. A Value with multiple ValueEnablers means any positive rule evaluation across the enablers result in a a visible Value.

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

Tests if this user can alter value enabler/value 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.
MethodassignValueEnablerToValue
Description

Adds an existing ValueEnabler to a Value.

Parametersosid.id.IdvalueEnablerIdthe Id of the ValueEnabler
osid.id.IdvalueIdthe Id of the Value
ErrorsALREADY_EXISTS valueEnablerId is already applied to valueId
NOT_FOUND valueEnablerId or valueId not found
NULL_ARGUMENT valueEnablerId or valueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignValueEnablerFromValue
Description

Removes a ValueEnabler from a Value.

Parametersosid.id.IdvalueEnablerIdthe Id of the ValueEnabler
osid.id.IdvalueIdthe Id of the Value
ErrorsNOT_FOUND valueEnablerId or valueId not found or valueEnablerId is not applied to valueId
NULL_ARGUMENT valueEnablerId or valueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceValueEnablers
Description

Tests if this user can order ValueEnablers. 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 ValueEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveValueEnablerAhead
Description

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

Parametersosid.id.IdvalueEnablerIdthe Id of a ValueEnabler
osid.id.IdvalueIdthe Id of a Value
osid.id.IdreferenceIdthe reference value enabler Id
ErrorsNOT_FOUND valueEnabelrId, valueId, or referenceId not found or, valueEnablerId, or referenceId not related to valueId
NULL_ARGUMENT valueEnablerId, valueId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveValueEnablerBehind
Description

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

Parametersosid.id.IdvalueEnablerIdthe Id of a ValueEnabler
osid.id.IdvalueIdthe Id of a Value
osid.id.IdreferenceIdthe reference value enabler Id
ErrorsNOT_FOUND valueEnabelrId, valueId, or referenceId not found or, valueEnablerId, or referenceId not related to valueId
NULL_ARGUMENT valueEnablerId, valueId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderValueEnablers
Description

Reorders a set of value enablers for a value.

Parametersosid.id.Id[]valueEnablerIdsthe Ids for a set of ValueEnablers
osid.id.IdvalueIdthe Id of a Value
ErrorsNOT_FOUND valueId not found or, a valueEnablerId not related to valueId
NULL_ARGUMENT valueEnablerIds or valueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.