Interface | osid.configuration.rules.ValueEnablerConfigurationAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignValueEnablers | ||
Description |
Tests if this user can alter value
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 | canAssignValueEnablersToConfiguration | ||
Description |
Tests if this user can alter value
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 value 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 | getAssignableConfigurationIdsForValueEnabler | ||
Description |
Gets a list of configurations including and under the given configuration node in which a specific value enabler can be assigned. | ||
Parameters | osid.id.Id | configurationId | the Id of the Configuration |
osid.id.Id | valueEnablerId | the Id of the ValueEnabler | |
Return | osid.id.IdList | list of assignable configuration Ids | |
Errors | NULL_ARGUMENT | configurationId or valueEnablerId is
null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignValueEnablerToConfiguration | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | valueEnablerId | the Id of the ValueEnabler |
osid.id.Id | configurationId | the Id of the Configuration | |
Errors | ALREADY_EXISTS | valueEnablerId is already assigned to configurationId
| |
NOT_FOUND | valueEnablerId or configurationId not found | ||
NULL_ARGUMENT | valueEnablerId or configurationId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignValueEnablerFromConfiguration | ||
Description |
Removes a | ||
Parameters | osid.id.Id | valueEnablerId | the Id of the ValueEnabler |
osid.id.Id | configurationId | the Id of the Configuration | |
Errors | NOT_FOUND | valueEnablerId or configurationId not found
or valueEnablerId is not assigned to configurationId
| |
NULL_ARGUMENT | valueEnablerId or configurationId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignValueEnablerToConfiguration | ||
Description |
Moves a | ||
Parameters | osid.id.Id | valueEnablerId | the Id of the ValueEnabler |
osid.id.Id | fromConfigurationId | the Id of the current Configuration | |
osid.id.Id | toConfigurationId | the Id of the destination Configuration | |
Errors | NOT_FOUND | valueEnablerId, fromConfigurationId, or
toConfigurationId not found or valueEnablerId not
mapped to fromConfigurationId | |
NULL_ARGUMENT | valueEnablerId, cromConfigurationId, or
toConfigurationId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |