Interface | osid.workflow.ProcessAdminSession | ||
---|---|---|---|
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 | getOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Office Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getOffice | ||
Description |
Gets the | ||
Return | osid.workflow.Office | the office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateProcesses | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Process creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateProcessWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | processRecordTypes | array of process record types |
Return | boolean | true if Process creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | processRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcessFormForCreate | ||
Description |
Gets the process form for creating new processes. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | processRecordTypes | array of process record types |
Return | osid.workflow.ProcessForm | the process form | |
Errors | NULL_ARGUMENT | processRecordTypes 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 | createProcess | ||
Description |
Creates a new | ||
Parameters | osid.workflow.ProcessForm | processForm | the form for this Process |
Return | osid.workflow.Process | the new Process | |
Errors | ILLEGAL_STATE | processForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | processForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | processForm did not originate from
getProcessFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateProcesses | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Process modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcessFormForUpdate | ||
Description |
Gets the process form for updating an existing process. A new process form should be requested for each update transaction. | ||
Parameters | osid.id.Id | processId | the Id of the Process |
Return | osid.workflow.ProcessForm | the process form | |
Errors | NOT_FOUND | processId is not found | |
NULL_ARGUMENT | processId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateProcess | ||
Description |
Updates an existing process. | ||
Parameters | osid.workflow.ProcessForm | processForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | processForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | processForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | processForm did not originate from
getProcessFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteProcesses | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Process deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteProcess | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | processId | the Id of the Process to remove |
Errors | NOT_FOUND | processId not found | |
NULL_ARGUMENT | processId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageProcessAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Process aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasProcess | ||
Description |
Adds an | ||
Parameters | osid.id.Id | processId | the Id of a Process |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | processId not found | ||
NULL_ARGUMENT | processId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canAssignCompetencies | ||
Description |
Tests if this user can assign competencies to process.
A return of true does not guarantee successful
authorization. A return of false indicates that it is
known assigning a competency will result in a | ||
Return | boolean | false if competency assignment is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | addCompetency | ||
Description |
Adds a competency to a process. | ||
Parameters | osid.id.Id | processId | the processId Id |
osid.id.Id | competencyId | the competency Id | |
Errors | ALREADY_EXISTS | competency already part of work | |
NOT_FOUND | competencyId or processId is not found | ||
NULL_ARGUMENT | competencyId or processId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeCompetency | ||
Description |
Removes a competency from a process. | ||
Parameters | osid.id.Id | processId | the process Id |
osid.id.Id | competencyId | the competency Id | |
Errors | NOT_FOUND | competency is not part of process | |
NULL_ARGUMENT | processId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removeCompetencies | ||
Description |
Removes all competency from a process. | ||
Parameters | osid.id.Id | processId | the process Id |
Errors | NOT_FOUND | processId is not found | |
NULL_ARGUMENT | processId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |