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

This session provides methods to re-assign ParameterProcessorEnabler to Configuration mappings. A ParameterProcessorEnabler may appear in multiple Configuration objects and removing the last reference to a ParameterProcessorEnabler 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 ParameterProcessorEnabler to another Configuration is not a copy operation (eg: does not change its Id ).

MethodcanAssignParameterProcessorEnablers
Description

Tests if this user can alter parameter processor 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.
MethodcanAssignParameterProcessorEnablersToConfiguration
Description

Tests if this user can alter parameter processor 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 parameter processor 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.
MethodgetAssignableConfigurationIdsForParameterProcessorEnabler
Description

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

Parametersosid.id.IdconfigurationIdthe Id of the Configuration
osid.id.IdparameterProcessorEnablerIdthe Id of the ParameterProcessorEnabler
Returnosid.id.IdListlist of assignable configuration Ids
ErrorsNULL_ARGUMENT configurationId or parameterProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignParameterProcessorEnablerToConfiguration
Description

Adds an existing ParameterProcessorEnabler to an Configuration.

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

Removes a ParameterProcessorEnabler from an Configuration.

Parametersosid.id.IdparameterProcessorEnablerIdthe Id of the ParameterProcessorEnabler
osid.id.IdconfigurationIdthe Id of the Configuration
ErrorsNOT_FOUND parameterProcessorEnablerId or configurationId or parameterProcessorEnablerId is not assigned to configurationId
NULL_ARGUMENT parameterProcessorEnablerId or configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.