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

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

MethodcanAssignParameterProcessors
Description

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

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

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

Parametersosid.id.IdconfigurationIdthe Id of the Configuration
osid.id.IdparameterProcessorIdthe Id of the ParameterProcessor
Returnosid.id.IdListlist of assignable configuration Ids
ErrorsNULL_ARGUMENT configurationId or parameterProcessorId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignParameterProcessorToConfiguration
Description

Adds an existing ParameterProcessor to an Configuration.

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

Removes a ParameterProcessor from a Configuration.

Parametersosid.id.IdparameterProcessorIdthe Id of the ParameterProcessor
osid.id.IdconfigurationIdthe Id of the Configuration
ErrorsNOT_FOUND parameterProcessorId or configurationId not found or parameterProcessorId is not assigned to configurationId
NULL_ARGUMENT parameterProcessorId or configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignParameterProcessorToConfiguration
Description

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

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