OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepProcessorAdminSession
Implementsosid.OsidSession
Description

This session creates and removes step processors. The data for create and update is provided via the StepProcessorForm.

MethodgetOfficeId
Description

Gets the Office Id associated with this session.

Returnosid.id.Idthe Office Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOffice
Description

Gets the Office associated with this session.

Returnosid.workflow.Officethe office
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateStepProcessor
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 StepProcessor will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if StepProcessor creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateStepProcessorWithRecordTypes
Description

Tests if this user can create a single StepProcessor using the desired record types. While WorkflowRulesManager.getStepProcessorRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific StepProcessor. Providing an empty array tests if a StepProcessor can be created with no records.

Parametersosid.type.Type[]stepProcessorRecordTypesarray of step processor record types
Returnboolean true if StepProcessor creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT stepProcessorRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorFormForCreate
Description

Gets the step processor form for creating new step processors. A new form should be requested for each create transaction.

Parametersosid.type.Type[]stepProcessorRecordTypesarray of step processor record types
Returnosid.workflow.rules.StepProcessorFormthe step processor form
ErrorsNULL_ARGUMENT stepProcessorRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateStepProcessor
Description

Creates a new StepProcessor.

Parametersosid.workflow.rules.StepProcessorFormstepProcessorFormthe form for this StepProcessor
Returnosid.workflow.rules.StepProcessorthe new StepProcessor
ErrorsILLEGAL_STATE stepProcessorForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT stepProcessorForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED stepProcessorForm did not originate from getStepProcessorFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateStepProcessors
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 StepProcessor will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if StepProcessor modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetStepProcessorFormForUpdate
Description

Gets the step processor form for updating an existing step processor. A new step processor form should be requested for each update transaction.

Parametersosid.id.IdstepProcessorIdthe Id of the StepProcessor
Returnosid.workflow.rules.StepProcessorFormthe step processor form
ErrorsNOT_FOUND stepProcessorId is not found
NULL_ARGUMENT stepProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateStepProcessor
Description

Updates an existing step processor.

Parametersosid.workflow.rules.StepProcessorFormstepProcessorFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE stepProcessorForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT stepProcessorForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED stepProcessorForm did not originate from getStepProcessorFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteStepProcessors
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 StepProcessor will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if StepProcessor deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteStepProcessor
Description

Deletes a StepProcessor.

Parametersosid.id.IdstepProcessorIdthe Id of the StepProcessor to remove
ErrorsNOT_FOUND stepProcessorId not found
NULL_ARGUMENT stepProcessorId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageStepProcessorAliases
Description

Tests if this user can manage Id aliases for step processors. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if StepProcessor aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasStepProcessor
Description

Adds a Id to a StepProcessor for the purpose of creating compatibility. The primary Id of the StepProcessor is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another step processor. it is reassigned to the given step processor Id.

Parametersosid.id.IdstepProcessorIdthe Id of a StepProcessor
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND stepProcessorId not found
NULL_ARGUMENT stepProcessorId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.