Interface | osid.configuration.rules.ValueEnablerRuleApplicationSession | ||
---|---|---|---|
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 | canAssignValueEnablers | ||
Description |
Tests if this user can alter value enabler/value
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 | assignValueEnablerToValue | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | valueEnablerId | the Id of the ValueEnabler |
osid.id.Id | valueId | the Id of the Value | |
Errors | ALREADY_EXISTS | valueEnablerId is already applied to valueId | |
NOT_FOUND | valueEnablerId or valueId not found | ||
NULL_ARGUMENT | valueEnablerId or valueId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignValueEnablerFromValue | ||
Description |
Removes a | ||
Parameters | osid.id.Id | valueEnablerId | the Id of the ValueEnabler |
osid.id.Id | valueId | the Id of the Value | |
Errors | NOT_FOUND | valueEnablerId or valueId not found or
valueEnablerId is not applied to valueId | |
NULL_ARGUMENT | valueEnablerId or valueId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSequenceValueEnablers | ||
Description |
Tests if this user can order | ||
Return | boolean | false if ValueEnabler ordering is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | moveValueEnablerAhead | ||
Description |
Reorders value enablers for a value by moving the specified value enabler in front of a reference value enabler. | ||
Parameters | osid.id.Id | valueEnablerId | the Id of a ValueEnabler |
osid.id.Id | valueId | the Id of a Value | |
osid.id.Id | referenceId | the reference value enabler Id | |
Errors | NOT_FOUND | valueEnabelrId, valueId, or referenceId not
found or, valueEnablerId, or referenceId not
related to valueId | |
NULL_ARGUMENT | valueEnablerId, valueId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | moveValueEnablerBehind | ||
Description |
Reorders value enablers for a value by moving the specified value enabler behind a reference value enabler. | ||
Parameters | osid.id.Id | valueEnablerId | the Id of a ValueEnabler |
osid.id.Id | valueId | the Id of a Value | |
osid.id.Id | referenceId | the reference value enabler Id | |
Errors | NOT_FOUND | valueEnabelrId, valueId, or referenceId not
found or, valueEnablerId, or referenceId not
related to valueId | |
NULL_ARGUMENT | valueEnablerId, valueId, or referenceId is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | orderValueEnablers | ||
Description |
Reorders a set of value enablers for a value. | ||
Parameters | osid.id.Id[] | valueEnablerIds | the Ids for a set of ValueEnablers |
osid.id.Id | valueId | the Id of a Value | |
Errors | NOT_FOUND | valueId not found or, a valueEnablerId not
related to valueId | |
NULL_ARGUMENT | valueEnablerIds or valueId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |