| Interface | osid.configuration.rules.ParameterProcessorEnablerRuleApplicationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | This session provides methods to apply  | ||
| Method | getConfigurationId | ||
| Description | Gets the  | ||
| Return | osid.id.Id | the  Configuration Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getConfiguration | ||
| Description | Gets the  | ||
| Return | osid.configuration.Configuration | the configuration | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignParameterProcessorEnablers | ||
| Description | Tests if this user can alter parameter processor 
                    enabler/parameter processor 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 | assignParameterProcessorEnablerToParameterProcessor | ||
| Description | Adds an existing  | ||
| Parameters | osid.id.Id | parameterProcessorEnablerId | the  Id of the ParameterProcessorEnabler  | 
| osid.id.Id | parameterProcessorId | the  Id of the ParameterProcessor  | |
| Errors | ALREADY_EXISTS |  parameterProcessorEnablerId is already applied to 
parameterProcessorId  | |
| NOT_FOUND |  parameterProcessorEnablerId or parameterProcessorId 
not found | ||
| NULL_ARGUMENT |  parameterProcessorEnablerId or parameterProcessorId 
is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignParameterProcessorEnablerFromParameterProcessor | ||
| Description | Removes a  | ||
| Parameters | osid.id.Id | parameterProcessorEnablerId | the  Id of the ParameterProcessorEnabler  | 
| osid.id.Id | parameterProcessorId | the  Id of the ParameterProcessor  | |
| Errors | NOT_FOUND |  parameterProcessorEnablerId or parameterProcessorId 
not found or parameterProcessorEnablerId is not applied 
to parameterProcessorId  | |
| NULL_ARGUMENT |  parameterProcessorEnablerId or parameterProcessorId 
is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceParameterProcessorEnablers | ||
| Description | Tests if this user can order  | ||
| Return | boolean |  false if ParameterProcessorEnabler ordering 
is not authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveParameterProcessorEnablerAhead | ||
| Description | Reorders parameter processor enablers for a parameter processor by moving the specified parameter processor enabler in front of a reference parameter enabler. | ||
| Parameters | osid.id.Id | parameterProcessorEnablerId | the  Id of a ParameterProcessorEnabler  | 
| osid.id.Id | parameterEnablerId | the  Id of a ParameterProcessor  | |
| osid.id.Id | referenceId | the reference parameter processor enabler  Id  | |
| Errors | NOT_FOUND |  parameterProcessorEnablerId, parameterEnablerId, or 
referenceId not found or, parameterProcessorEnablerId, or referenceId not related to parameterEnablerId  | |
| NULL_ARGUMENT |  parameterProcessorEnablerId, parameterEnablerId, or 
referenceId is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveParameterProcessorEnablerBehind | ||
| Description | Reorders parameter processor enablers for a parameter by moving the specified parameter processor enabler behind a reference parameter processor enabler. | ||
| Parameters | osid.id.Id | parameterProcessorEnablerId | the  Id of a ParameterProcessorEnabler  | 
| osid.id.Id | parameterEnablerId | the  Id of a ParameterProcessor  | |
| osid.id.Id | referenceId | the reference parameter processor enabler  Id  | |
| Errors | NOT_FOUND |  parameterProcessorEnablerId, parameterEnablerId, or 
referenceId not found or, parameterProcessorEnablerId, or referenceId not related to parameterEnablerId  | |
| NULL_ARGUMENT |  parameterProcessorEnablerId, parameterEnablerId, or 
referenceId is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderParameterProcessorEnablers | ||
| Description | Reorders a set of parameter processor enablers for a parameter processor. | ||
| Parameters | osid.id.Id[] | parameterProcessorEnablerIds | the  Ids for a set of ParameterProcessorEnablers 
 | 
| osid.id.Id | parameterProcessorId | the  Id of a ParameterProcessor  | |
| Errors | NOT_FOUND |  parameterProcessorId not found or, a 
parameterProcessorEnablerId not related to parameterProcessorId 
 | |
| NULL_ARGUMENT |  parameterProcessorEnablerIds or parameterProcessorId, 
is null  | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |