Interface | osid.control.rules.DeviceEnablerAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes device 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 | canCreateDeviceEnabler | ||
Description |
Tests if this user can create device 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 DeviceEnabler creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateDeviceEnablerWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | deviceEnablerRecordTypes | array of device enabler record types |
Return | boolean | true if DeviceEnabler creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | deviceEnablerRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDeviceEnablerFormForCreate | ||
Description |
Gets the device enabler form for creating new device enablers. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | deviceEnablerRecordTypes | array of device enabler record types |
Return | osid.control.rules.DeviceEnablerForm | the device enabler form | |
Errors | NULL_ARGUMENT | deviceEnablerRecordTypes 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 | createDeviceEnabler | ||
Description |
Creates a new | ||
Parameters | osid.control.rules.DeviceEnablerForm | deviceEnablerForm | the form for this DeviceEnabler |
Return | osid.control.rules.DeviceEnabler | the new DeviceEnabler | |
Errors | ILLEGAL_STATE | deviceEnablerForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | deviceEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | deviceEnablerForm did not originate from
getDeviceEnablerFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateDeviceEnablers | ||
Description |
Tests if this user can update device 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 DeviceEnabler modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDeviceEnablerFormForUpdate | ||
Description |
Gets the device enabler form for updating an existing device enabler. A new device enabler form should be requested for each update transaction. | ||
Parameters | osid.id.Id | deviceEnablerId | the Id of the DeviceEnabler |
Return | osid.control.rules.DeviceEnablerForm | the device enabler form | |
Errors | NOT_FOUND | deviceEnablerId is not found | |
NULL_ARGUMENT | deviceEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateDeviceEnabler | ||
Description |
Updates an existing device enabler. | ||
Parameters | osid.control.rules.DeviceEnablerForm | deviceEnablerForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | deviceEnablerForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | deviceEnablerForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | deviceEnablerForm did not originate from
getDeviceEnablerFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteDeviceEnablers | ||
Description |
Tests if this user can delete device 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 DeviceEnabler deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteDeviceEnabler | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | deviceEnablerId | the Id of the DeviceEnabler to remove |
Errors | NOT_FOUND | deviceEnablerId not found | |
NULL_ARGUMENT | deviceEnablerId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageDeviceEnablerAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if DeviceEnabler aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasDeviceEnabler | ||
Description |
Adds an | ||
Parameters | osid.id.Id | deviceEnablerId | the Id of a DeviceEnabler |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | deviceEnablerId not found | ||
NULL_ARGUMENT | deviceEnablerId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |