org.openlowcode.design.data.properties.basic

Class Lifecycle

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.ObjectElement

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

org.openlowcode.design.data.properties.basic.Lifecycle

All Implemented Interfaces:

NamedInterface

public class Lifecycle
extends Property<Lifecycle>

This property provides a lifecycle to an object. Lifecycle is defined by a TransitionChoiceCategory.
Dependent property : UniqueIdentified

Author:

Open Lowcode SAS

Nested Class Summary

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

Property.PropertyElementDisplayDefinition

Field Summary

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
Lifecycle(TransitionChoiceCategory lifecyclehelper) creates a new lifecycle property with the default label (state)
Lifecycle(TransitionChoiceCategory lifecyclehelper, java.lang.String newstatelabel) creates a new lifecycle property with a customized label (something more specific to the context than state)
Lifecycle(TransitionChoiceCategory lifecyclehelper, java.lang.String newstatelabel, java.lang.String nonreleasedlabel) creates a new lifecycle property with a customized label (something more specific to the context than state), and also a non-released label showing in red

Method Summary

Modifier and Type	Method and Description
void	controlAfterParentDefinition() to be implemented if controls have to be performed after parent is added.
static AutomaticActionMarker	getChangeStateAutomaticAction(DataObjectDefinition parent) returns a reference to change state action to provide a privilege just for this action
UniqueIdentified	getDependentPropertyUniqueIdentified()
java.util.ArrayList<DataObjectDefinition>	getExternalObjectDependence()
java.lang.String	getJavaType()
TransitionChoiceCategory	getLifecycleHelper()
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[]	getPropertyInitMethod() this method uses the context data for creation and the data-input for standard creation.
TransitionChoiceCategory	getTransitionChoiceCategory()
java.lang.String	getUnreleasedWarning()
boolean	hasChoiceValue(ChoiceValue value) checks if the lifecycle helper has the following choice value
void	setFinalSettings() an abstract method to be implemented by properties for finalizations to be performed after all data objects have been created.
void	writeDependentClass(SourceGenerator sg, Module module) only send here classes that are NOT data objects.

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, generatePropertyHelperToFile, 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, getPropertyHelperName, 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

Constructor Detail

Lifecycle

public Lifecycle(TransitionChoiceCategory lifecyclehelper)

creates a new lifecycle property with the default label (state)

Parameters:

lifecyclehelper - the definition of the lifecycle (list of status and transitions, also definition of default, working and final states)

Lifecycle

public Lifecycle(TransitionChoiceCategory lifecyclehelper,
                 java.lang.String newstatelabel)

creates a new lifecycle property with a customized label (something more specific to the context than state)

Parameters:

lifecyclehelper - the definition of the lifecycle (list of status and transitions)

newstatelabel - name of the state for the object (could be a synonym like status...)

Lifecycle

public Lifecycle(TransitionChoiceCategory lifecyclehelper,
                 java.lang.String newstatelabel,
                 java.lang.String nonreleasedlabel)

creates a new lifecycle property with a customized label (something more specific to the context than state), and also a non-released label showing in red

Parameters:

lifecyclehelper - the definition of the lifecycle (list of status and transitions)

newstatelabel - name of the state for the object (could be a synonym like status...)

nonreleasedlabel - a warning for non-released data

Method Detail

getLifecycleHelper

public TransitionChoiceCategory getLifecycleHelper()

Returns:

the transition choice category used for the lifecycle (list of status and transitions, also definition of default, working, and final states)

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<Lifecycle>

getTransitionChoiceCategory

public TransitionChoiceCategory getTransitionChoiceCategory()

Returns:

get the lifecycle helper transition category

getDependentPropertyUniqueIdentified

public UniqueIdentified getDependentPropertyUniqueIdentified()

Returns:

the dependent property unique identified

hasChoiceValue

public boolean hasChoiceValue(ChoiceValue value)

checks if the lifecycle helper has the following choice value

Parameters:

value - value to check

Returns:

true if the lifecycle helper (transition choice category) has the value

getUnreleasedWarning

public java.lang.String getUnreleasedWarning()

Returns:

the unreleased warning label shown on non-frozen data (by default, it is null, and no warning is shown)

getChangeStateAutomaticAction

public static AutomaticActionMarker getChangeStateAutomaticAction(DataObjectDefinition parent)

returns a reference to change state action to provide a privilege just for this action

Parameters:

parent - parent data object

Returns:

the marker to the change state action

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

getExternalObjectDependence

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

Specified by:

getExternalObjectDependence in class Property<Lifecycle>

Returns:

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

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<Lifecycle>

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<Lifecycle>

Returns:

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

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<Lifecycle>

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<Lifecycle>

Returns:

a number of lines of java code