org.openlowcode.design.data.properties.basic

Class ComplexWorkflow

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.ObjectElement

org.openlowcode.design.data.Property<ObjectWithWorkflow>

org.openlowcode.design.data.properties.basic.ObjectWithWorkflow

org.openlowcode.design.data.properties.basic.ComplexWorkflow

All Implemented Interfaces:

NamedInterface

public class ComplexWorkflow
extends ObjectWithWorkflow

A complex workflow with an ad-hoc multi-step workflow with conditions and routings

Author:

Open Lowcode SAS

Nested Class Summary

Nested classes/interfaces inherited from class org.openlowcode.design.data.properties.basic.ObjectWithWorkflow

ObjectWithWorkflow.ObjectWorkflowTable

Nested classes/interfaces inherited from class org.openlowcode.design.data.Property

Property.PropertyElementDisplayDefinition

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMAIL_DAILY
static java.lang.String	EMAIL_DELAY15MIN
static java.lang.String	EMAIL_DELAY2H
static java.lang.String	EMAIL_NONE
static java.lang.String	EMAIL_NOW
static java.lang.String	EMAIL_WEEKLY

Fields inherited from class org.openlowcode.design.data.Property

FIELDDIPLSAY_TITLE_MOD, FIELDDISPLAY_BOTTOMNOTES, FIELDDISPLAY_NONE, FIELDDISPLAY_NORMAL, FIELDDISPLAY_NORMAL_MOD, FIELDDISPLAY_TITLE, parent

Constructor Summary

Constructors

Constructor and Description
ComplexWorkflow(WorkflowTriggerCondition automaticworkflowtrigger, java.lang.String emailtype) creates a complex workflow with the given trigger and e-mail type

Method Summary

Modifier and Type	Method and Description
void	controlAfterParentDefinition() to be implemented if controls have to be performed after parent is added.
void	generatePropertyHelperToFile(SourceGenerator sg, Module module) Generates in the data folder the property helper.
java.util.ArrayList<DataObjectDefinition>	getExternalObjectDependence()
WorkflowStep	getFirstStep()
java.lang.String	getJavaType()
Lifecycle	getParentLifecycle()
java.lang.String[]	getPropertyDeepCopyStatement() Returns the required deepcopy statement for the property, sends back null if nothing is required.
java.lang.String[]	getPropertyExtractMethod() This method should return non null value only if setCreationDataInputForUpdate() is set
java.lang.String	getPropertyHelperName() A property can have a specific property helper.
java.lang.String[]	getPropertyInitMethod() this method uses the context data for creation and the data-input for standard creation.
ComplexWorkflowClose	getWorkflowClose()
ComplexWorkflowGround	getWorkflowGround()
void	registerNonTaskWorkflowStep(WorkflowStep step) registers a step that is not a user task
void	registerUserTask(UserTask task) registers a user task in the catalog of tasks of the workflows.
void	setFinalSettings() an abstract method to be implemented by properties for finalizations to be performed after all data objects have been created.
void	setFirstStep(WorkflowStep firststep) defines the first step of the workflow
void	writeDependentClass(SourceGenerator sg, Module module) only send here classes that are NOT data objects.

Methods inherited from class org.openlowcode.design.data.properties.basic.ObjectWithWorkflow

getObjectWorkflowTable, setWorkflowTableWidgetPriority

Methods inherited from class org.openlowcode.design.data.Property

addBusinessRule, addChoiceCategoryHelper, addContextForDataCreation, addDataAccessMethod, addDataInput, addDependentProperty, addDisplayProfileForProperty, addElement, addElement, addElementasSearchElement, addExternalObjectProperty, addFieldOverrides, addMethodAdditionalProcessing, addObjectToAuthorityMapper, addPropertyGenerics, addStringHelper, getBusinessRule, getBusinessRuleByName, getBusinessRuleNumber, getChoiceCategoryByKey, getChoiceCategoryKeyNumber, getChoiceCategoryNumber, getContextDataForCreation, getContextDataForCreationSize, getDataAccessMethod, getDataAccessMethod, getDataAccessMethodnumber, getDataInputForCreation, getDataInputSize, getDataObjectConstructorAttributes, getDataObjectFieldName, getDependentProperties, getDisplayDefinitionForElement, getDisplayProfileForProperty, getDisplayProfileForPropertyNumber, getExternalObject, getExternalObjectProperty, getExternalObjectPropertySize, getFieldOverridesat, getFieldOverridesNumber, getInstancename, getJavaClassType, getMethodAdditionalProcessing, getMethodAdditionalProcessingnumber, getParent, getPropertyclassname, getPropertyGenerics, getPropertyGenericsSize, getPropertyGenericsString, hasDynamicDefinitionHelper, hasInterface, hasStaticQuery, hideDataInputForCreation, isDatainputatbottom, isDataInputHiddenForCreation, isDataInputUsedForUpdate, isLegacy, isPropertyHelperTransient, setAsLegacy, setDatainputatbottom, setDataInputForUpdate, setDynamicDefinitionHelper, setExtraAttributes, writeAdditionalDefinition

Methods inherited from class org.openlowcode.design.data.ObjectElement

AddElementWithSearch, addIndex, getDisplayname, getElements, getIndex, getSearchWidgetList, getTooltip

Methods inherited from class org.openlowcode.tools.misc.Named

changeName, cleanName, equals, getName

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EMAIL_NONE

public static final java.lang.String EMAIL_NONE

EMAIL_NOW

public static final java.lang.String EMAIL_NOW

See Also:

Constant Field Values

EMAIL_DELAY15MIN

public static final java.lang.String EMAIL_DELAY15MIN

See Also:

Constant Field Values

EMAIL_DELAY2H

public static final java.lang.String EMAIL_DELAY2H

See Also:

Constant Field Values

EMAIL_DAILY

public static final java.lang.String EMAIL_DAILY

See Also:

Constant Field Values

EMAIL_WEEKLY

public static final java.lang.String EMAIL_WEEKLY

See Also:

Constant Field Values

Constructor Detail

ComplexWorkflow

public ComplexWorkflow(WorkflowTriggerCondition automaticworkflowtrigger,
                       java.lang.String emailtype)

creates a complex workflow with the given trigger and e-mail type

Parameters:

automaticworkflowtrigger - type of trigger (at the start of object, reaching of a lifecycle...)

emailtype - type of e-mail (as defined in a static String in this class)

Method Detail

getParentLifecycle

public Lifecycle getParentLifecycle()

Returns:

get the parent lifecycle property

registerUserTask

public void registerUserTask(UserTask task)

registers a user task in the catalog of tasks of the workflows. Checks if the code is unique

Parameters:

task - a task to register in the workflow

registerNonTaskWorkflowStep

public void registerNonTaskWorkflowStep(WorkflowStep step)

registers a step that is not a user task

Parameters:

step - step to register

setFirstStep

public void setFirstStep(WorkflowStep firststep)

defines the first step of the workflow

Parameters:

firststep - first step of the workflow (should already be registered with the workflow)

getFirstStep

public WorkflowStep getFirstStep()

Returns:

get the workflow first step

getWorkflowClose

public ComplexWorkflowClose getWorkflowClose()

Returns:

the workflow close step (can be used several times in the workflow)

getWorkflowGround

public ComplexWorkflowGround getWorkflowGround()

Returns:

the workflow ground step (can be used several times in the workflow)

getPropertyInitMethod

public java.lang.String[] getPropertyInitMethod()

Description copied from class: Property

this method uses the context data for creation and the data-input for standard creation. This does not include automatically generated data, but data entered by user and context only.

Specified by:

getPropertyInitMethod in class Property<ObjectWithWorkflow>

Returns:

a non-null array of size 0 to n with the method and arguments required

getPropertyExtractMethod

public java.lang.String[] getPropertyExtractMethod()

Description copied from class: Property

This method should return non null value only if setCreationDataInputForUpdate() is set

Specified by:

getPropertyExtractMethod in class Property<ObjectWithWorkflow>

Returns:

a non-null array of size 0 to n with the method and arguments required

getExternalObjectDependence

public java.util.ArrayList<DataObjectDefinition> getExternalObjectDependence()

Specified by:

getExternalObjectDependence in class Property<ObjectWithWorkflow>

Returns:

a list of data object definitions that are linked to this property. This helps making necessary imports in the data object definition file

setFinalSettings

public void setFinalSettings()

Description copied from class: Property

an abstract method to be implemented by properties for finalizations to be performed after all data objects have been created. THis is especially useful for properties that refer to other data objects (e.g. LinkProperty )

Specified by:

setFinalSettings in class Property<ObjectWithWorkflow>

getJavaType

public java.lang.String getJavaType()

Specified by:

getJavaType in class ObjectElement

Returns:

the java type of the object element in data object code

writeDependentClass

public void writeDependentClass(SourceGenerator sg,
                                Module module)
                         throws java.io.IOException

Description copied from class: ObjectElement

only send here classes that are NOT data objects. For data object dependencies for properties, use the property method getExternalObjectDependence TODO: needs to replace this logic by the sending of list of strings to remove duplicates issue #12

Specified by:

writeDependentClass in class ObjectElement

Throws:

java.io.IOException

controlAfterParentDefinition

public void controlAfterParentDefinition()

Description copied from class: Property

to be implemented if controls have to be performed after parent is added.

Overrides:

controlAfterParentDefinition in class Property<ObjectWithWorkflow>

getPropertyHelperName

public java.lang.String getPropertyHelperName()

Description copied from class: Property

A property can have a specific property helper. It is generated in the data folder, and is also called at the end of the property definition creator, with the singleton .get method

Overrides:

getPropertyHelperName in class Property<ObjectWithWorkflow>

Returns:

null if no specific helper, or the helper class name if helper exists

generatePropertyHelperToFile

public void generatePropertyHelperToFile(SourceGenerator sg,
                                         Module module)
                                  throws java.io.IOException

Description copied from class: Property

Generates in the data folder the property helper.

Overrides:

generatePropertyHelperToFile in class Property<ObjectWithWorkflow>

Parameters:

sg - source generator

module - parent module

Throws:

java.io.IOException - if any error is encountered writing the source file

getPropertyDeepCopyStatement

public java.lang.String[] getPropertyDeepCopyStatement()

Description copied from class: Property

Returns the required deepcopy statement for the property, sends back null if nothing is required.

Specified by:

getPropertyDeepCopyStatement in class Property<ObjectWithWorkflow>

Returns:

a number of lines of java code