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

This session creates and removes step constrainer enablers. The data for create and update is provided via the StepConstrainerEnablerForm.

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

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

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

Parametersosid.type.Type[]stepConstrainerEnablerRecordTypesarray of step constrainer enabler record types
Returnboolean true if StepConstrainerEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT stepConstrainerEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetStepConstrainerEnablerFormForCreate
Description

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

Parametersosid.type.Type[]stepConstrainerEnablerRecordTypesarray of step constrainer enabler record types
Returnosid.workflow.rules.StepConstrainerEnablerFormthe step constrainer enabler form
ErrorsNULL_ARGUMENT stepConstrainerEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateStepConstrainerEnabler
Description

Creates a new StepConstrainerEnabler.

Parametersosid.workflow.rules.StepConstrainerEnablerFormstepConstrainerEnablerFormthe form for this StepConstrainerEnabler
Returnosid.workflow.rules.StepConstrainerEnablerthe new StepConstrainerEnabler
ErrorsILLEGAL_STATE stepConstrainerEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT stepConstrainerEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED stepConstrainerEnablerForm did not originate from getStepConstrainerEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateStepConstrainerEnablers
Description

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

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

Parametersosid.id.IdstepConstrainerEnablerIdthe Id of the StepConstrainerEnabler
Returnosid.workflow.rules.StepConstrainerEnablerFormthe step constrainer enabler form
ErrorsNOT_FOUND stepConstrainerEnablerId is not found
NULL_ARGUMENT stepConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateStepConstrainerEnabler
Description

Updates an existing step constrainer enabler.

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

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

Deletes a StepConstrainerEnabler.

Parametersosid.id.IdstepConstrainerEnablerIdthe Id of the StepConstrainerEnabler to remove
ErrorsNOT_FOUND stepConstrainerEnablerId not found
NULL_ARGUMENT stepConstrainerEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageStepConstrainerEnablerAliases
Description

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

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

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