org.openlowcode.design.data.properties.basic

Class LinkedFromChildren

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.ObjectElement

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

org.openlowcode.design.data.properties.basic.LinkedFromChildren

All Implemented Interfaces:

NamedInterface

public class LinkedFromChildren
extends Property<LinkedFromChildren>

This property is added to objects that are parents for a parent to child relation
Warning: this should not be added directly by developer

the child object has the property. LinkedToParent
Dependent property : UniqueIdentified

Author:

Open Lowcode SAS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	LinkedFromChildren.ChildrenTable the table showing all children on the parent object

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
LinkedFromChildren(java.lang.String name, DataObjectDefinition childobjectforlink, LinkedToParent<?> originobjectproperty) creates a linked from children property with default display
LinkedFromChildren(java.lang.String name, DataObjectDefinition childobjectforlink, LinkedToParent<?> originobjectproperty, java.lang.String linedisplayforgrid, java.lang.String columndisplayforgrid, java.lang.String secondarycolumndisplayforgrid, java.lang.String[] cellfieldsforgrid) creates a linked from children property with grid display
LinkedFromChildren(java.lang.String name, DataObjectDefinition childobjectforlink, LinkedToParent<?> originobjectproperty, WidgetDisplayPriority linkedfromchildrenwidgetdisplaypriority) creates a linked from children property with specified display priority for the child table
LinkedFromChildren(java.lang.String name, DataObjectDefinition childobjectforlink, LinkedToParent<?> originobjectproperty, WidgetDisplayPriority linkedfromchildrenwidgetdisplaypriority, java.lang.String linedisplayforgrid, java.lang.String columndisplayforgrid, java.lang.String secondarycolumndisplayforgrid, java.lang.String[] cellfieldsforgrid) creates a linked from children property with grid display with specific display priority

Method Summary

Modifier and Type	Method and Description
void	addActionOnSelectedChildId(DynamicActionDefinition action) adds an action button on the parent object page to launch an action on the selected child object in the children table
void	controlAfterParentDefinition() to be implemented if controls have to be performed after parent is added.
Widget	generateChildrenTableWidget() provides the widget showing the children table to allow to give it a different priority
DataObjectDefinition	getChildObject()
java.util.ArrayList<DataObjectDefinition>	getExternalObjectDependence()
java.lang.String	getJavaType()
LinkedToParent<?>	getOriginObjectProperty()
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.
LinkedToParent<?>	getRelatedLinkedToParent()
void	setFinalSettings() an abstract method to be implemented by properties for finalizations to be performed after all data objects have been created.
protected void	setSpecificTitleForChildrenTable(java.lang.String specifictitleforchildrentable) sets a specific label for the children table widget on the parent
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

LinkedFromChildren

public LinkedFromChildren(java.lang.String name,
                          DataObjectDefinition childobjectforlink,
                          LinkedToParent<?> originobjectproperty,
                          WidgetDisplayPriority linkedfromchildrenwidgetdisplaypriority)

creates a linked from children property with specified display priority for the child table

Parameters:

name - unique name amongst linked from children property of this object

childobjectforlink - definition of the child object

originobjectproperty - LinkedToParent property on the child object

linkedfromchildrenwidgetdisplaypriority - specific widget display priority for the child table widget

LinkedFromChildren

public LinkedFromChildren(java.lang.String name,
                          DataObjectDefinition childobjectforlink,
                          LinkedToParent<?> originobjectproperty)

creates a linked from children property with default display

Parameters:

name - unique name amongst linked from children property of this object

childobjectforlink - definition of the child object

originobjectproperty - LinkedToParent property on the child object

LinkedFromChildren

public LinkedFromChildren(java.lang.String name,
                          DataObjectDefinition childobjectforlink,
                          LinkedToParent<?> originobjectproperty,
                          WidgetDisplayPriority linkedfromchildrenwidgetdisplaypriority,
                          java.lang.String linedisplayforgrid,
                          java.lang.String columndisplayforgrid,
                          java.lang.String secondarycolumndisplayforgrid,
                          java.lang.String[] cellfieldsforgrid)

creates a linked from children property with grid display with specific display priority

Parameters:

name - unique name amongst linked from children property of this object

childobjectforlink - definition of the child object

originobjectproperty - LinkedToParent property on the child object

linkedfromchildrenwidgetdisplaypriority - widget display priority

linedisplayforgrid - the column used for line display

columndisplayforgrid - the column used for column display

secondarycolumndisplayforgrid - the column used for secondary column display (leave it null if not used)

cellfieldsforgrid - the name of the fields to show as content in the grid

LinkedFromChildren

public LinkedFromChildren(java.lang.String name,
                          DataObjectDefinition childobjectforlink,
                          LinkedToParent<?> originobjectproperty,
                          java.lang.String linedisplayforgrid,
                          java.lang.String columndisplayforgrid,
                          java.lang.String secondarycolumndisplayforgrid,
                          java.lang.String[] cellfieldsforgrid)

creates a linked from children property with grid display

Parameters:

name - unique name amongst linked from children property of this object

childobjectforlink - definition of the child object

originobjectproperty - LinkedToParent property on the child object

linedisplayforgrid - the column used for line display

columndisplayforgrid - the column used for column display

secondarycolumndisplayforgrid - the column used for secondary column display (leave it null if not used)

cellfieldsforgrid - the name of the fields to show as content in the grid

Method Detail

getRelatedLinkedToParent

public LinkedToParent<?> getRelatedLinkedToParent()

Returns:

the related linked to parent property on the child object

generateChildrenTableWidget

public Widget generateChildrenTableWidget()

provides the widget showing the children table to allow to give it a different priority

Returns:

the widget of the children table

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

getOriginObjectProperty

public LinkedToParent<?> getOriginObjectProperty()

getChildObject

public DataObjectDefinition getChildObject()

setSpecificTitleForChildrenTable

protected void setSpecificTitleForChildrenTable(java.lang.String specifictitleforchildrentable)

sets a specific label for the children table widget on the parent

Parameters:

specifictitleforchildrentable - specific title

addActionOnSelectedChildId

public void addActionOnSelectedChildId(DynamicActionDefinition action)

adds an action button on the parent object page to launch an action on the selected child object in the children table

Parameters:

action - an action with a unique input argument being the object id of the child

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

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

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

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

Returns:

a number of lines of java code

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

Returns:

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