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

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

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.
MethodcanCreateStepConstrainer
Description

Tests if this user can create step constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a StepConstrainer 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 StepConstrainer creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateStepConstrainerWithRecordTypes
Description

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

Parametersosid.type.Type[]stepConstrainerRecordTypesarray of step constrainer record types
Returnboolean true if StepConstrainer creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT stepConstrainerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerFormForCreate
Description

Gets the step constrainer form for creating new step constrainers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]stepConstrainerRecordTypesarray of step constrainer record types
Returnosid.workflow.rules.StepConstrainerFormthe step constrainer form
ErrorsNULL_ARGUMENT stepConstrainerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateStepConstrainer
Description

Creates a new StepConstrainer.

Parametersosid.workflow.rules.StepConstrainerFormstepConstrainerFormthe form for this StepConstrainer
Returnosid.workflow.rules.StepConstrainerthe new StepConstrainer
ErrorsILLEGAL_STATE stepConstrainerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT stepConstrainerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED stepConstrainerForm did not originate from getStepConstrainerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateStepConstrainers
Description

Tests if this user can update step constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a StepConstrainer 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 StepConstrainer modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerFormForUpdate
Description

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

Parametersosid.id.IdstepConstrainerIdthe Id of the StepConstrainer
Returnosid.workflow.rules.StepConstrainerFormthe step constrainer form
ErrorsNOT_FOUND stepConstrainerId is not found
NULL_ARGUMENT stepConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateStepConstrainer
Description

Updates an existing step constrainer.

Parametersosid.workflow.rules.StepConstrainerFormstepConstrainerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE stepConstrainerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT stepConstrainerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED stepConstrainerForm did not originate from getStepConstrainerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteStepConstrainers
Description

Tests if this user can delete step constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a StepConstrainer 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 StepConstrainer deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteStepConstrainer
Description

Deletes a StepConstrainer.

Parametersosid.id.IdstepConstrainerIdthe Id of the StepConstrainer to remove
ErrorsNOT_FOUND stepConstrainerId not found
NULL_ARGUMENT stepConstrainerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageStepConstrainerAliases
Description

Tests if this user can manage Id aliases for step constrainers. 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 StepConstrainer aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasStepConstrainer
Description

Adds a Id to a StepConstrainer for the purpose of creating compatibility. The primary Id of the StepConstrainer 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 constrainer. it is reassigned to the given step constrainer Id.

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