| Interface | osid.configuration.rules.ParameterProcessorConfigurationAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | This session provides methods to re-assign   Adding a reference of a  | ||
| Method | canAssignParameterProcessors | ||
| 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  | ||
| Return | boolean |  false if mapping is not authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignParameterProcessorsToConfiguration | ||
| 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  | ||
| Parameters | osid.id.Id | configurationId | the  Id of the Configuration  | 
| Return | boolean |  false if mapping is not authorized, true otherwise | |
| Errors | NULL_ARGUMENT |  configurationId is null  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableConfigurationIds | ||
| Description | Gets a list of configurations including and under the given configuration node in which any parameter processor can be assigned. | ||
| Parameters | osid.id.Id | configurationId | the  Id of the Configuration  | 
| Return | osid.id.IdList | list of assignable configuration  Ids  | |
| Errors | NULL_ARGUMENT |  configurationId is null  | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableConfigurationIdsForParameterProcessor | ||
| Description | Gets a list of configurations including and under the given configuration node in which a specific parameter processor can be assigned. | ||
| Parameters | osid.id.Id | configurationId | the  Id of the Configuration  | 
| osid.id.Id | parameterProcessorId | the  Id of the ParameterProcessor  | |
| Return | osid.id.IdList | list of assignable configuration  Ids  | |
| Errors | NULL_ARGUMENT |  configurationId or parameterProcessorId is null  | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignParameterProcessorToConfiguration | ||
| Description | Adds an existing  | ||
| Parameters | osid.id.Id | parameterProcessorId | the  Id of the ParameterProcessor  | 
| osid.id.Id | configurationId | the  Id of the Configuration  | |
| Errors | ALREADY_EXISTS |  parameterProcessorId is already assigned to 
configurationId  | |
| NOT_FOUND |  parameterProcessorId or configurationId not 
found | ||
| NULL_ARGUMENT |  parameterProcessorId or configurationId is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignParameterProcessorFromConfiguration | ||
| Description | Removes a  | ||
| Parameters | osid.id.Id | parameterProcessorId | the  Id of the ParameterProcessor  | 
| osid.id.Id | configurationId | the  Id of the Configuration  | |
| Errors | NOT_FOUND |  parameterProcessorId or configurationId not 
found or parameterProcessorId is not assigned to 
configurationId  | |
| NULL_ARGUMENT |  parameterProcessorId or configurationId is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignParameterProcessorToConfiguration | ||
| Description | Moves a  | ||
| Parameters | osid.id.Id | parameterProcessorId | the  Id of the ParameterProcessor  | 
| osid.id.Id | fromConfigurationId | the  Id of the current Configuration  | |
| osid.id.Id | toConfigurationId | the  Id of the destination Configuration  | |
| Errors | NOT_FOUND |  parameterProcessorId fromConfigurationId, or 
toConfigurationId not found or parameterProcessorId not 
mapped to fromConfigurationId  | |
| NULL_ARGUMENT |  parameterProcessorId, fromConfigurationId, or 
toConfigurationId is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |