Interface | osid.control.InputAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
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 | canCreateInputs | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Input creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateInputWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | inputRecordTypes | array of input record types |
Return | boolean | true if Input creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | inputRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getInputFormForCreate | ||
Description |
Gets the input form for creating new inputs. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | deviceId | a device Id |
osid.id.Id | controllerId | a controller Id | |
osid.type.Type[] | inputRecordTypes | array of input record types | |
Return | osid.control.InputForm | the input form | |
Errors | NOT_FOUND | deviceId or controllerId is not found | |
NULL_ARGUMENT | deviceId, controllerId, or inputRecordTypes
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 | createInput | ||
Description |
Creates a new | ||
Parameters | osid.control.InputForm | inputForm | the form for this Input |
Return | osid.control.Input | the new Input | |
Errors | ILLEGAL_STATE | inputForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | inputForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | inputForm did not originate from
getInputFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateInputs | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Input modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInputFormForUpdate | ||
Description |
Gets the input form for updating an existing input. A new input form should be requested for each update transaction. | ||
Parameters | osid.id.Id | inputId | the Id of the Input |
Return | osid.control.InputForm | the input form | |
Errors | NOT_FOUND | inputId is not found | |
NULL_ARGUMENT | inputId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateInput | ||
Description |
Updates an existing input. | ||
Parameters | osid.control.InputForm | inputForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | inputForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | inputForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | inputForm did not originate from
getInputFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteInputs | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Input deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteInput | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | inputId | the Id of the Input to remove |
Errors | NOT_FOUND | inputId not found | |
NULL_ARGUMENT | inputId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageInputAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Input aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasInput | ||
Description |
Adds an | ||
Parameters | osid.id.Id | inputId | the Id of a Input |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | inputId not found | ||
NULL_ARGUMENT | inputId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |