Interface | osid.configuration.ValueAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, This session includes an | ||
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 associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportValueConditions | ||
Description |
Tests if applying conditions to values is supported. | ||
Return | boolean | true if Value conditions are supported,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateValues | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Value creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateValueWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | valueRecordTypes | array of value record types |
Return | boolean | true if Value creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | valueRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueFormForCreate | ||
Description |
Gets the form for creating new values. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | parameterId | the parameter |
osid.type.Type[] | valueRecordTypes | array of value record types | |
Return | osid.configuration.ValueForm | the value form | |
Errors | NOT_FOUND | parameterId is not found | |
NULL_ARGUMENT | parameterId or valueRecordTypes is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createValue | ||
Description |
Creates a value. | ||
Parameters | osid.configuration.ValueForm | valueForm | the form |
Return | osid.configuration.Value | the value | |
Errors | ILLEGAL_STATE | valueForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | valueForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | valueForm did not originate from
getValueFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateValues | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Value modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueFormForUpdate | ||
Description |
Gets the value form for updating an existing value. A new value form should be requested for each update transaction. | ||
Parameters | osid.id.Id | valueId | the Id of the Value |
Return | osid.configuration.ValueForm | the value form | |
Errors | NOT_FOUND | the value is not found | |
NULL_ARGUMENT | parameterId or valueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateValue | ||
Description |
Updates an existing value. | ||
Parameters | osid.configuration.ValueForm | valueForm | the form containing the elemnts to be updated |
Errors | ILLEGAL_STATE | valueForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | parameterId, valueId or valueForm is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | valueForm did not originate from
getValueFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteValues | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Value deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteValue | ||
Description |
Deletes the specified value. | ||
Parameters | osid.id.Id | valueId | the Id of the Value to delete |
Errors | NOT_FOUND | valueId is not found | |
NULL_ARGUMENT | valueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageValueAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Value aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasValue | ||
Description |
Adds an | ||
Parameters | osid.id.Id | valueId | the Id of a Value |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | valueId not found | ||
NULL_ARGUMENT | valueId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |