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

This session provides methods to re-assign ValueEnabler to Configuration mappings. A ValueEnabler may appear in multiple Configuration objects and removing the last reference to a ValueEnabler is the equivalent of deleting it. Each Configuration may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a ValueEnabler to another Configuration is not a copy operation (eg: does not change its Id ).

MethodcanAssignValueEnablers
Description

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

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

Parametersosid.id.IdconfigurationIdthe Id of the Configuration
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT configurationId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableConfigurationIds
Description

Gets a list of configurations including and under the given configuration node in which any value enabler can be assigned.

Parametersosid.id.IdconfigurationIdthe Id of the Configuration
Returnosid.id.IdListlist of assignable configuration Ids
ErrorsNULL_ARGUMENT configurationId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableConfigurationIdsForValueEnabler
Description

Gets a list of configurations including and under the given configuration node in which a specific value enabler can be assigned.

Parametersosid.id.IdconfigurationIdthe Id of the Configuration
osid.id.IdvalueEnablerIdthe Id of the ValueEnabler
Returnosid.id.IdListlist of assignable configuration Ids
ErrorsNULL_ARGUMENT configurationId or valueEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignValueEnablerToConfiguration
Description

Adds an existing ValueEnabler to a Configuration.

Parametersosid.id.IdvalueEnablerIdthe Id of the ValueEnabler
osid.id.IdconfigurationIdthe Id of the Configuration
ErrorsALREADY_EXISTS valueEnablerId is already assigned to configurationId
NOT_FOUND valueEnablerId or configurationId not found
NULL_ARGUMENT valueEnablerId or configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignValueEnablerFromConfiguration
Description

Removes a ValueEnabler from a Configuration.

Parametersosid.id.IdvalueEnablerIdthe Id of the ValueEnabler
osid.id.IdconfigurationIdthe Id of the Configuration
ErrorsNOT_FOUND valueEnablerId or configurationId not found or valueEnablerId is not assigned to configurationId
NULL_ARGUMENT valueEnablerId or configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignValueEnablerToConfiguration
Description

Moves a ValueEnabler from one Configuration to another. Mappings to other Configurations are unaffected.

Parametersosid.id.IdvalueEnablerIdthe Id of the ValueEnabler
osid.id.IdfromConfigurationIdthe Id of the current Configuration
osid.id.IdtoConfigurationIdthe Id of the destination Configuration
ErrorsNOT_FOUND valueEnablerId, fromConfigurationId, or toConfigurationId not found or valueEnablerId not mapped to fromConfigurationId
NULL_ARGUMENT valueEnablerId, cromConfigurationId, or toConfigurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.