| Interface | osid.configuration.ParameterConfigurationAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description |
This session provides methods to re-assign Moving or adding a reference of a | ||
| Method | canAssignParameterConfigurations | ||
| 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 | ||
| Return | boolean | false if parameter configuration assignment is not
authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignParametersToConfiguration | ||
| 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
| ||
| Parameters | osid.id.Id | configurationId | the Id of the Configuration |
| Return | boolean | false if configuration 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 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 | getAssignableConfigurationIdsForParameter | ||
| Description |
Gets a list of configurations including and under the given configuration node in which a specific parameter can be assigned. | ||
| Parameters | osid.id.Id | configurationId | the Id of the Configuration |
osid.id.Id | parameterId | the Id of the Parameter | |
| Return | osid.id.IdList | list of assignable configuration Ids | |
| Errors | NULL_ARGUMENT | configurationId or parameterId is null
| |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignParameterToConfiguration | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | parameterId | the Id of the Parameter |
osid.id.Id | configurationId | the Id of the Configuration | |
| Errors | ALREADY_EXISTS | parameterId and configurationId already
mapped | |
| NOT_FOUND | parameterId or configurationId not found | ||
| NULL_ARGUMENT | parameterId or configurationId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignParameterFromConfiguration | ||
| Description |
Removes a | ||
| Parameters | osid.id.Id | parameterId | the Id of the Parameter |
osid.id.Id | configurationId | the Id of the Configuration | |
| Errors | NOT_FOUND | parameterId or configurationId not found or
is not mapped | |
| NULL_ARGUMENT | parameterId or configurationId is null
| ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignParameterToConfiguration | ||
| Description |
Moves a | ||
| Parameters | osid.id.Id | parameterId | the Id of the Parameter |
osid.id.Id | fromConfigurationId | the Id of the current Configuration | |
osid.id.Id | toConfigurationId | the Id of the destination Configuration | |
| Errors | NOT_FOUND | parameterId fromConfigurationId, or toConfigurationId
not found or creditId not mapped to
fromConfigurationId | |
| NULL_ARGUMENT | parameterId, fromConfigurationId, or
toConfigurationId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |