org.openlowcode.design.data.properties.basic

Class UniqueIdentified

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.design.data.ObjectElement

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

org.openlowcode.design.data.properties.basic.UniqueIdentified

All Implemented Interfaces:

NamedInterface

public class UniqueIdentified
extends Property<UniqueIdentified>

This property allows unique storage and retrieval independently from the database by giving it a unique persistent technical id. It is necessary for most other properties. *
Dependent property : StoredObject

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
UniqueIdentified() creates the unique identified property

Method Summary

Modifier and Type	Method and Description
void	addActionOnObjectId(DynamicActionDefinition action) adds action in the main button band of the object.
void	addActionOnObjectId(DynamicActionDefinition action, boolean actioninmanagetab) adds an action on the object, either in the main button band, or in the manage tab
void	controlAfterParentDefinition() to be implemented if controls have to be performed after parent is added.
NamedList<DynamicActionDefinition>	getActionListonObjectId()
NamedList<DynamicActionDefinition>	getActionListonObjectIdForManageTab()
java.util.ArrayList<DataObjectDefinition>	getExternalObjectDependence()
java.lang.String	getJavaType()
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.
StoredObject	getStoredObject()
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

UniqueIdentified

public UniqueIdentified()

creates the unique identified property

Method Detail

getActionListonObjectId

public NamedList<DynamicActionDefinition> getActionListonObjectId()

Returns:

the list of actions on object id to be added to button band of the object page

getActionListonObjectIdForManageTab

public NamedList<DynamicActionDefinition> getActionListonObjectIdForManageTab()

Returns:

the list of actions on object id to be added to the manage tab of the object page

getStoredObject

public StoredObject getStoredObject()

Returns:

get the related property stored object

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

Returns:

a number of lines of java code

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

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

Returns:

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

addActionOnObjectId

public void addActionOnObjectId(DynamicActionDefinition action)

adds action in the main button band of the object. The action should have a single input attribute being the data object id

Parameters:

action - adds an action on the object id. The action should have a single input attribute being the data object id

addActionOnObjectId

public void addActionOnObjectId(DynamicActionDefinition action,
                                boolean actioninmanagetab)

adds an action on the object, either in the main button band, or in the manage tab

Parameters:

action - adds an action on the object id. The action should have a single input attribute being the data object id

actioninmanagetab - if true, action is put in manage tabs, if false, action is directly in the action button

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

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

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

Returns:

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