Interface | osid.configuration.rules.ValueEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes value enablers. The data
for create and update is provided via the | ||
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 | canCreateValueEnabler | ||
Description |
Tests if this user can create value enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known creating a
| ||
Return | boolean | false if ValueEnabler creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateValueEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | valueEnablerRecordTypes | array of value enabler record types |
Return | boolean | true if ValueEnabler creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | valueEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueEnablerFormForCreate | ||
Description |
Gets the value enabler form for creating new value enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | valueEnablerRecordTypes | array of value enabler record types |
Return | osid.configuration.rules.ValueEnablerForm | the value enabler form | |
Errors | NULL_ARGUMENT | valueEnablerRecordTypes 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 | createValueEnabler | ||
Description |
Creates a new | ||
Parameters | osid.configuration.rules.ValueEnablerForm | valueEnablerForm | the form for this ValueEnabler |
Return | osid.configuration.rules.ValueEnabler | the new ValueEnabler | |
Errors | ILLEGAL_STATE | valueEnablerForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | valueEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | valueEnablerForm did not originate from
getValueEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateValueEnablers | ||
Description |
Tests if this user can update value enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known updating a
| ||
Return | boolean | false if ValueEnabler modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueEnablerFormForUpdate | ||
Description |
Gets the value enabler form for updating an existing value enabler. A new value enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | valueEnablerId | the Id of the ValueEnabler |
Return | osid.configuration.rules.ValueEnablerForm | the value enabler form | |
Errors | NOT_FOUND | valueEnablerId is not found | |
NULL_ARGUMENT | valueEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateValueEnabler | ||
Description |
Updates an existing value enabler. | ||
Parameters | osid.configuration.rules.ValueEnablerForm | valueEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | valueEnablerForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | valueEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | valueEnablerForm did not originate from
getValueEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteValueEnablers | ||
Description |
Tests if this user can delete value enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known deleting a
| ||
Return | boolean | false if ValueEnabler deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteValueEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | valueEnablerId | the Id of the ValueEnabler to remove |
Errors | NOT_FOUND | valueEnablerId not found | |
NULL_ARGUMENT | valueEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageValueEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if ValueEnabler aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasValueEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | valueEnablerId | the Id of a ValueEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | valueEnablerId not found | ||
NULL_ARGUMENT | valueEnablerId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |