| Interface | osid.configuration.rules.ParameterProcessorEnablerConfigurationAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Adding a reference of a | ||
| Method | canAssignParameterProcessorEnablers | ||
| 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 | ||
| Return | boolean | false if mapping is not authorized, true
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignParameterProcessorEnablersToConfiguration | ||
| 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 | ||
| 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 enabler 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 | getAssignableConfigurationIdsForParameterProcessorEnabler | ||
| Description |
Gets a list of configurations including and under the given configuration node in which a specific parameter processor enabler can be assigned. | ||
| Parameters | osid.id.Id | configurationId | the Id of the Configuration |
osid.id.Id | parameterProcessorEnablerId | the Id of the ParameterProcessorEnabler | |
| Return | osid.id.IdList | list of assignable configuration Ids | |
| Errors | NULL_ARGUMENT | configurationId or parameterProcessorEnablerId
is null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignParameterProcessorEnablerToConfiguration | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | parameterProcessorEnablerId | the Id of the ParameterProcessorEnabler |
osid.id.Id | configurationId | the Id of the Configuration | |
| Errors | ALREADY_EXISTS | parameterProcessorEnablerId is already assigned to
configurationId | |
| NOT_FOUND | parameterProcessorEnablerId or configurationId
not found | ||
| NULL_ARGUMENT | parameterProcessorEnablerId or configurationId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignParameterProcessorEnablerFromConfiguration | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | parameterProcessorEnablerId | the Id of the ParameterProcessorEnabler |
osid.id.Id | configurationId | the Id of the Configuration | |
| Errors | NOT_FOUND | parameterProcessorEnablerId or configurationId
or parameterProcessorEnablerId is not assigned to
configurationId | |
| NULL_ARGUMENT | parameterProcessorEnablerId or configurationId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |