Interface | osid.workflow.rules.StepProcessorAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates and removes step processors. The data
for create and update is provided via the | ||
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 | canCreateStepProcessor | ||
Description |
Tests if this user can create step processors. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known creating a
| ||
Return | boolean | false if StepProcessor creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateStepProcessorWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | stepProcessorRecordTypes | array of step processor record types |
Return | boolean | true if StepProcessor creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | stepProcessorRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorFormForCreate | ||
Description |
Gets the step processor form for creating new step processors. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | stepProcessorRecordTypes | array of step processor record types |
Return | osid.workflow.rules.StepProcessorForm | the step processor form | |
Errors | NULL_ARGUMENT | stepProcessorRecordTypes 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 | createStepProcessor | ||
Description |
Creates a new | ||
Parameters | osid.workflow.rules.StepProcessorForm | stepProcessorForm | the form for this StepProcessor |
Return | osid.workflow.rules.StepProcessor | the new StepProcessor | |
Errors | ILLEGAL_STATE | stepProcessorForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | stepProcessorForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stepProcessorForm did not originate from
getStepProcessorFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateStepProcessors | ||
Description |
Tests if this user can update step processors. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known updating a
| ||
Return | boolean | false if StepProcessor modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getStepProcessorFormForUpdate | ||
Description |
Gets the step processor form for updating an existing step processor. A new step processor form should be requested for each update transaction. | ||
Parameters | osid.id.Id | stepProcessorId | the Id of the StepProcessor |
Return | osid.workflow.rules.StepProcessorForm | the step processor form | |
Errors | NOT_FOUND | stepProcessorId is not found | |
NULL_ARGUMENT | stepProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateStepProcessor | ||
Description |
Updates an existing step processor. | ||
Parameters | osid.workflow.rules.StepProcessorForm | stepProcessorForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | stepProcessorForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | stepProcessorForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | stepProcessorForm did not originate from
getStepProcessorFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteStepProcessors | ||
Description |
Tests if this user can delete step processors. A return
of true does not guarantee successful authorization. A
return of false indicates that it is known deleting a
| ||
Return | boolean | false if StepProcessor deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteStepProcessor | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | stepProcessorId | the Id of the StepProcessor to remove |
Errors | NOT_FOUND | stepProcessorId not found | |
NULL_ARGUMENT | stepProcessorId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageStepProcessorAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if StepProcessor aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasStepProcessor | ||
Description |
Adds a | ||
Parameters | osid.id.Id | stepProcessorId | the Id of a StepProcessor |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | stepProcessorId not found | ||
NULL_ARGUMENT | stepProcessorId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |