Interface | osid.rules.EngineAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an For updates, The delete operations delete This session includes an | ||
Method | canCreateEngines | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Engine creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateEngineWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | engineRecordTypes | array of engine record types |
Return | boolean | true if Engine creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | engineRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getEngineFormForCreate | ||
Description |
Gets the engine form for creating new engines. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | engineRecordTypes | array of engine record types |
Return | osid.rules.EngineForm | the engine form | |
Errors | NULL_ARGUMENT | engineRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form with requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createEngine | ||
Description |
Creates a new | ||
Parameters | osid.rules.EngineForm | engineForm | the form for this Engine |
Return | osid.rules.Engine | the new Engine | |
Errors | ILLEGAL_STATE | engineForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | engineForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | engineForm did not originate from
getEngineFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateEngines | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Engine modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getEngineFormForUpdate | ||
Description |
Gets the engine form for updating an existing engine. A new engine form should be requested for each update transaction. | ||
Parameters | osid.id.Id | engineId | the Id of the Engine |
Return | osid.rules.EngineForm | the engine form | |
Errors | NOT_FOUND | engineId is not found | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateEngine | ||
Description |
Updates an existing engine. | ||
Parameters | osid.rules.EngineForm | engineForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | engineForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | engineForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | engineForm did not originate from
getEngineFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteEngines | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Engine deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteEngine | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | engineId | the Id of the Engine to remove |
Errors | NOT_FOUND | engineId not found | |
NULL_ARGUMENT | engineId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageEngineAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Engine aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasEngine | ||
Description |
Adds an | ||
Parameters | osid.id.Id | engineId | the Id of an Engine |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | engineId not found | ||
NULL_ARGUMENT | engineId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |