Interface | osid.control.rules.InputEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes input enablers. The data
for create and update is provided via the | ||
Method | getSystemId | ||
Description |
Gets the | ||
Return | osid.id.Id | the System Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getSystem | ||
Description |
Gets the | ||
Return | osid.control.System | the system | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateInputEnabler | ||
Description |
Tests if this user can create input enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known creating an
| ||
Return | boolean | false if InputEnabler creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateInputEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | inputEnablerRecordTypes | array of input enabler record types |
Return | boolean | true if InputEnabler creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | inputEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getInputEnablerFormForCreate | ||
Description |
Gets the input enabler form for creating new input enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | inputEnablerRecordTypes | array of input enabler record types |
Return | osid.control.rules.InputEnablerForm | the input enabler form | |
Errors | NULL_ARGUMENT | inputEnablerRecordTypes 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 | createInputEnabler | ||
Description |
Creates a new | ||
Parameters | osid.control.rules.InputEnablerForm | inputEnablerForm | the form for this InputEnabler |
Return | osid.control.rules.InputEnabler | the new InputEnabler | |
Errors | ILLEGAL_STATE | inputEnablerForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | inputEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | inputEnablerForm did not originate from
getInputEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateInputEnablers | ||
Description |
Tests if this user can update input enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known updating an
| ||
Return | boolean | false if InputEnabler modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInputEnablerFormForUpdate | ||
Description |
Gets the input enabler form for updating an existing input enabler. A new input enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | inputEnablerId | the Id of the InputEnabler |
Return | osid.control.rules.InputEnablerForm | the input enabler form | |
Errors | NOT_FOUND | inputEnablerId is not found | |
NULL_ARGUMENT | inputEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateInputEnabler | ||
Description |
Updates an existing input enabler. | ||
Parameters | osid.control.rules.InputEnablerForm | inputEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | inputEnablerForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | inputEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | inputEnablerForm did not originate from
getInputEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteInputEnablers | ||
Description |
Tests if this user can delete input enablers. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known deleting an
| ||
Return | boolean | false if InputEnabler deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteInputEnabler | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | inputEnablerId | the Id of the InputEnabler to remove |
Errors | NOT_FOUND | inputEnablerId not found | |
NULL_ARGUMENT | inputEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageInputEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if InputEnabler aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasInputEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | inputEnablerId | the Id of an InputEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | inputEnablerId not found | ||
NULL_ARGUMENT | inputEnablerId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |