Interface | osid.process.StateAdminSession | ||
---|---|---|---|
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 | getProcessId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Process Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcess | ||
Description |
Gets the | ||
Return | osid.process.Process | the Process associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateStates | ||
Description |
Tests if this user can create | ||
Return | boolean | false if State creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateStateWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | stateRecordTypes | array of state record types |
Return | boolean | true if State creation using the specified
Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | stateRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getStateFormForCreate | ||
Description |
Gets the state form for creating new states. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | stateRecordTypes | array of state record types |
Return | osid.process.StateForm | the state form | |
Errors | NULL_ARGUMENT | stateRecordTypes 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 | createState | ||
Description |
Creates a new | ||
Parameters | osid.process.StateForm | stateForm | the form for this State |
Return | osid.process.State | the new State | |
Errors | ILLEGAL_STATE | stateForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | stateForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stateForm did not originate from
getStateFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateStates | ||
Description |
Tests if this user can update | ||
Return | boolean | false if State modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStateFormForUpdate | ||
Description |
Gets the state form for updating an existing state. A new state form should be requested for each update transaction. | ||
Parameters | osid.id.Id | stateId | the Id of the State |
Return | osid.process.StateForm | the state form | |
Errors | NOT_FOUND | stateId is not found | |
NULL_ARGUMENT | stateId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateState | ||
Description |
Updates an existing state. | ||
Parameters | osid.process.StateForm | stateForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | stateForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | stateId or stateForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stateForm did not originate from
getStateFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteStates | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if State deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteState | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | stateId | the Id of the State to remove |
Errors | NOT_FOUND | stateId not found | |
NULL_ARGUMENT | stateId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageStateAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if State aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasState | ||
Description |
Adds an | ||
Parameters | osid.id.Id | stateId | the Id of a State |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | stateId not found | ||
NULL_ARGUMENT | aliasId or stateId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |