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

This session provides methods to re-assign Parameters to Configurations. A Parameter may appear in multiple Configurations and removing the last reference to a Parameter is the equivalent of deleting it which may or may not be permitted. Each Configuration may have its own authorizations as to who is allowed to operate on it.

Moving or adding a reference of a Parameter to another Configuration is not a copy operation (eg: does not change its Id ).

MethodcanAssignParameterConfigurations
Description

Tests if this user can change parameter configuration mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not wish to offer assignment operations.

Returnboolean false if parameter configuration assignment is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignParametersToConfiguration
Description

Tests if this user can alter parameter/configuration parameters. A return of true does not guarantee successful authorization. A return of false indicates that it is known parameter 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 configuration 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 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.
MethodgetAssignableConfigurationIdsForParameter
Description

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

Parametersosid.id.IdconfigurationIdthe Id of the Configuration
osid.id.IdparameterIdthe Id of the Parameter
Returnosid.id.IdListlist of assignable configuration Ids
ErrorsNULL_ARGUMENT configurationId or parameterId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignParameterToConfiguration
Description

Adds an existing Parameter to a Configuration.

Parametersosid.id.IdparameterIdthe Id of the Parameter
osid.id.IdconfigurationIdthe Id of the Configuration
ErrorsALREADY_EXISTS parameterId and configurationId already mapped
NOT_FOUND parameterId or configurationId not found
NULL_ARGUMENT parameterId or configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignParameterFromConfiguration
Description

Removes a Parameter from a Configuration.

Parametersosid.id.IdparameterIdthe Id of the Parameter
osid.id.IdconfigurationIdthe Id of the Configuration
ErrorsNOT_FOUND parameterId or configurationId not found or is not mapped
NULL_ARGUMENT parameterId or configurationId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignParameterToConfiguration
Description

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

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