Property

java.lang.Object
- org.openlowcode.tools.misc.Named
- - org.openlowcode.design.data.ObjectElement
  - - org.openlowcode.design.data.Property<E>

All Implemented Interfaces:

NamedInterface

Direct Known Subclasses:

AutolinkObject, ComputedDecimal, CreationLog, CustomLoader, DataControl, FileContent, FlexibleDecimalFields, GenericLink, HasAutolink, ImageContent, Iterated, IteratedAutolink, IteratedLink, IteratedSubobject, LeftForLink, Lifecycle, LinkedFromChildren, LinkedFromChildrenForLocation, LinkedToParent, LinkObject, Located, Named, Numbered, NumberedForParent, ObjectWithWorkflow, Personal, PrintOut, RightForLink, Schedule, ScheduleDependency, Session, StoredObject, TargetDate, TimeSlot, TimeslotWithSessions, TransientParent, Trigger, UniqueIdentified, UpdateLog, Versioned
```
public abstract class Property<E extends Property<E>>
extends ObjectElement
```
A property is a feature of an object that may include some stored information, and some specific methods available inside business transactions. Properties are identified by their name, unique across the application. Different object types with the same properties can be treated by the same code as all the objects will implement an interface corresponding to the property.
Property behaviour during object lifecycle
The fields of a property are typically calculated by the property logic. However, it is possible to define that some fields are entered by users during the object creation or modification. In that case, a method will be implemented by the property to perform the update, as it is assumed that some pre-storage processing will be performed.
Property dependencies
Properties are typically dependent from each others. E.g. to link an object to another object using a simple link, you need both objects to be uniquely identified.

Properties are identified by their name (which should be unique per object), their classname (the same for the property whatever the context), and a generics class value if the property uses a generic. This is useful for properties that depend from other objects.
e.g. ClassNameHelper
ClassNameHelper propertynamehelper = ....

Author:

Open Lowcode SAS

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class Property.PropertyElementDisplayDefinition
A simple classe to define how to display a property element definition

Nested Classes
Modifier and Type	Class and Description
`class`	`Property.PropertyElementDisplayDefinition` A simple classe to define how to display a property element definition

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`FIELDDIPLSAY_TITLE_MOD`
`static int`	`FIELDDISPLAY_BOTTOMNOTES`
`static int`	`FIELDDISPLAY_NONE`
`static int`	`FIELDDISPLAY_NORMAL`
`static int`	`FIELDDISPLAY_NORMAL_MOD`
`static int`	`FIELDDISPLAY_TITLE`
`protected DataObjectDefinition`	`parent`

Constructor Summary

Constructors
Constructor and Description
`Property(java.lang.String name)` creates a property for the given name
`Property(java.lang.String name, java.lang.String propertyclassname)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addBusinessRule(PropertyBusinessRule<E> businessrule)`
`protected void`	`addChoiceCategoryHelper(java.lang.String name, ChoiceCategory category)` adds a choice category helper.
`protected void`	`addContextForDataCreation(ArgumentContent contextdata)` context for data creation is provided by the context.
`protected void`	`addDataAccessMethod(DataAccessMethod dam)` a data access method is a method defined by the property that will be available to the object for a business action
`protected void`	`addDataInput(ArgumentContent datainput)` sets data input (by default for creation).
`protected void`	`addDependentProperty(Property<?> property)` This defines a relation between the current property and the dependent property.
`void`	`addDisplayProfileForProperty(DisplayProfile displayprofile)` adds a display profile for this property.
`void`	`addElement(Element e)` adds a stored element to the property without any display or update setting
`void`	`addElement(Element e, java.lang.String display, java.lang.String tooltip, int fielddisplaymode, int fielddisplaypriority, int showcaractersintable)` /** adds a stored element with display of the field specified
`void`	`addElementasSearchElement(Element e, java.lang.String display, java.lang.String tooltip, int fielddisplaymode, int fielddisplaypriority, int showcaractersintable, SearchWidgetDefinition searchdef)` adds a stored element with display of the field specified and the field appearing in field searches
`protected void`	`addExternalObjectProperty(DataObjectDefinition externalobject, Property<?> externalobjectproperty)` adds an external object property to this property.
`protected void`	`addFieldOverrides(FieldOverrideForProperty override)` adds a Field Overrides for the given property.
`protected void`	`addMethodAdditionalProcessing(MethodAdditionalProcessing map)` adds a method additional processing to a related property
`protected void`	`addObjectToAuthorityMapper(java.lang.String name, ObjectToAuthorityMapper mapper)` adds
`void`	`addPropertyGenerics(PropertyGenerics generics)` adds a generics to the property.
`protected void`	`addStringHelper(java.lang.String name, java.lang.String payload)` A string helper is a string input defined when defining the property on a given object.
`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.
`PropertyBusinessRule<E>`	`getBusinessRule(int index)` gets the business rule at the given index
`PropertyBusinessRule<E>`	`getBusinessRuleByName(java.lang.String name)` queries the business rule by name, return null if no corresponding business rule is found
`int`	`getBusinessRuleNumber()`
`ChoiceCategory`	`getChoiceCategoryByKey(java.lang.String key)` gets the choice category by the given key
`java.util.Iterator<java.lang.String>`	`getChoiceCategoryKeyNumber()` An iterator on choice categories used by this property.
`int`	`getChoiceCategoryNumber()` provides the number of choice categories used by this property.
`ArgumentContent`	`getContextDataForCreation(int index)` gets the type of context data for creation of an object with this property
`int`	`getContextDataForCreationSize()` gets the number of context data for creation of property.
`DataAccessMethod`	`getDataAccessMethod(int index)` get the data access method at the provided index
`DataAccessMethod`	`getDataAccessMethod(java.lang.String name)` get data access method for the given name
`int`	`getDataAccessMethodnumber()`
`ArgumentContent`	`getDataInputForCreation(int index)` gets the type of data input (argument content) for creation of an object with this property
`int`	`getDataInputSize()`
`java.lang.String`	`getDataObjectConstructorAttributes()`
`java.lang.String`	`getDataObjectFieldName()`
`Property<?>[]`	`getDependentProperties()` this method should returns all properties this property is dependent on.
`Property.PropertyElementDisplayDefinition`	`getDisplayDefinitionForElement(Element e)` gets the display definition for a given element of the property
`DisplayProfile`	`getDisplayProfileForProperty(int index)` gets the display profile at the given index
`int`	`getDisplayProfileForPropertyNumber()` gets the number of display profiles defined for this property
`DataObjectDefinition`	`getExternalObject(int index)` returns an external object for which this property has reference
`abstract java.util.ArrayList<DataObjectDefinition>`	`getExternalObjectDependence()`
`Property<?>`	`getExternalObjectProperty(int index)` the related property for the external object at the given index
`int`	`getExternalObjectPropertySize()`
`FieldOverrideForProperty`	`getFieldOverridesat(int index)` gets the field override at the given index
`int`	`getFieldOverridesNumber()` get the number of field overrides defined for the object
`java.lang.String`	`getInstancename()`
`java.lang.String`	`getJavaClassType()`
`MethodAdditionalProcessing`	`getMethodAdditionalProcessing(int index)` get the method additional processing at the given index
`int`	`getMethodAdditionalProcessingnumber()`
`DataObjectDefinition`	`getParent()` get the parent DataObjectDefinition for the property
`java.lang.String`	`getPropertyclassname()` the property class name (different for the instance name in case the same property has several instances)
`abstract java.lang.String[]`	`getPropertyDeepCopyStatement()` Returns the required deepcopy statement for the property, sends back null if nothing is required.
`abstract java.lang.String[]`	`getPropertyExtractMethod()` This method should return non null value only if setCreationDataInputForUpdate() is set
`PropertyGenerics`	`getPropertyGenerics(int index)` gest the property generics at the given index
`int`	`getPropertyGenericsSize()`
`java.lang.String`	`getPropertyGenericsString()`
`java.lang.String`	`getPropertyHelperName()` A property can have a specific property helper.
`abstract java.lang.String[]`	`getPropertyInitMethod()` this method uses the context data for creation and the data-input for standard creation.
`boolean`	`hasDynamicDefinitionHelper()`
`boolean`	`hasInterface()` only properties that exist with only one instance can have an interface and so be referenced as significant property for the PropertyGenerics of anotherproperty
`boolean`	`hasStaticQuery()`
`protected void`	`hideDataInputForCreation()` will use the data input only for update
`boolean`	`isDatainputatbottom()`
`boolean`	`isDataInputHiddenForCreation()` an indicator telling if data input should be hidden for creation (and so shown on update page only)
`boolean`	`isDataInputUsedForUpdate()` data input argument can be shown on create (default) but also on update.
`boolean`	`isLegacy()`
`boolean`	`isPropertyHelperTransient()`
`protected void`	`setAsLegacy()` sets this property as legacy
`void`	`setDatainputatbottom(boolean datainputatbottom)` allows to set if data input for the property during creation page is at top or bottom of objects
`protected void`	`setDataInputForUpdate()` will also use the data input for creation for the update of object
`void`	`setDynamicDefinitionHelper()` When a property has a dynamic definition helper, the definition helper has to be defined for each instance of the object.
`protected void`	`setExtraAttributes(java.lang.String extraattributes)` This allows a property to add specific attributes to pass to the property definition when creating it.
`abstract void`	`setFinalSettings()` an abstract method to be implemented by properties for finalizations to be performed after all data objects have been created.
`void`	`writeAdditionalDefinition(SourceGenerator sg)` This method allows a property to define extra conditions when writing additional definition on the property

Methods inherited from class org.openlowcode.design.data.ObjectElement
AddElementWithSearch, addIndex, getDisplayname, getElements, getIndex, getJavaType, getSearchWidgetList, getTooltip, writeDependentClass

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
  - parent
```
protected DataObjectDefinition parent
```
  - FIELDDISPLAY_NONE
```
public static final int FIELDDISPLAY_NONE
```
    See Also:
    
    Constant Field Values
  - FIELDDISPLAY_BOTTOMNOTES
```
public static final int FIELDDISPLAY_BOTTOMNOTES
```
    See Also:
    
    Constant Field Values
  - FIELDDISPLAY_NORMAL
```
public static final int FIELDDISPLAY_NORMAL
```
    See Also:
    
    Constant Field Values
  - FIELDDISPLAY_NORMAL_MOD
```
public static final int FIELDDISPLAY_NORMAL_MOD
```
    See Also:
    
    Constant Field Values
  - FIELDDISPLAY_TITLE
```
public static final int FIELDDISPLAY_TITLE
```
    See Also:
    
    Constant Field Values
  - FIELDDIPLSAY_TITLE_MOD
```
public static final int FIELDDIPLSAY_TITLE_MOD
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Property
```
public Property(java.lang.String name,
                java.lang.String propertyclassname)
```
    Parameters:
    
    name - the name of the instance of the property (e.g. Folder Structure, the specific instance of "linkedtoparent" property)
    
    propertyclassname - name of the class of the property (e.g. linkedtoparent). In case propertyclassname is provided, the propertyname is 'propertclassname'+"for"+'name' (e.g. 'linkedtoparentforfolderstructure' )
  - Property
```
public Property(java.lang.String name)
```
    creates a property for the given name
    
    Parameters:
    
    name - the name of the instance of the property on the object (if the name depends from the instance, then the common classname should be specified
- Method Detail
  - isDatainputatbottom
```
public boolean isDatainputatbottom()
```
    Returns:
    
    true if data input is at bottom for property field
  - setDatainputatbottom
```
public void setDatainputatbottom(boolean datainputatbottom)
```
    allows to set if data input for the property during creation page is at top or bottom of objects
    
    Parameters:
    
    datainputatbottom - true if data input is at bottom
  - setExtraAttributes
```
protected void setExtraAttributes(java.lang.String extraattributes)
```
    This allows a property to add specific attributes to pass to the property definition when creating it. It should be rendered as a string, including preceding comma, e.g. ",2,3" for two additional integer attributes.
    
    Parameters:
    
    extraattributes - extra attributes for property creation
  - addExternalObjectProperty
```
protected void addExternalObjectProperty(DataObjectDefinition externalobject,
                                         Property<?> externalobjectproperty)
```
    adds an external object property to this property. Checks are done so that properties are only added once per type of external object
    
    Parameters:
    
    externalobject - other object
    
    externalobjectproperty - property of the other object that this property is related to
  - getExternalObjectPropertySize
```
public int getExternalObjectPropertySize()
```
    Returns:
    
    the number of external object properties
  - getExternalObject
```
public DataObjectDefinition getExternalObject(int index)
```
    returns an external object for which this property has reference
    
    Parameters:
    
    index - an integer between 0 (included) and getExternalObjectPropertySize() (excluded)
    
    Returns:
    
    the data object at the given index
  - getExternalObjectProperty
```
public Property<?> getExternalObjectProperty(int index)
```
    the related property for the external object at the given index
    
    Parameters:
    
    index - an integer between 0 (included) and getExternalObjectPropertySize() (excluded)
    
    Returns:
    
    the external object property at the given index
  - getBusinessRuleNumber
```
public int getBusinessRuleNumber()
```
    Returns:
    
    the number of business rules
  - getBusinessRule
```
public PropertyBusinessRule<E> getBusinessRule(int index)
```
    gets the business rule at the given index
    
    Parameters:
    
    index - a number between 0 (included) and getBusinessRuleNumber (excluded)
    
    Returns:
    
    the business rule at the given index
  - getBusinessRuleByName
```
public PropertyBusinessRule<E> getBusinessRuleByName(java.lang.String name)
```
    queries the business rule by name, return null if no corresponding business rule is found
    
    Parameters:
    
    name - name of the business rule
    
    Returns:
    
    the property with the given name if exists, null else
  - getPropertyInitMethod
```
public abstract java.lang.String[] getPropertyInitMethod()
```
    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.
    
    Returns:
    
    a non-null array of size 0 to n with the method and arguments required
  - getPropertyExtractMethod
```
public abstract java.lang.String[] getPropertyExtractMethod()
```
    This method should return non null value only if setCreationDataInputForUpdate() is set
    
    Returns:
    
    a non-null array of size 0 to n with the method and arguments required
  - getPropertyDeepCopyStatement
```
public abstract java.lang.String[] getPropertyDeepCopyStatement()
```
    Returns the required deepcopy statement for the property, sends back null if nothing is required.
    
    Returns:
    
    a number of lines of java code
  - getContextDataForCreationSize
```
public int getContextDataForCreationSize()
```
    gets the number of context data for creation of property. Context data is provided by the creation page
    
    Returns:
    
    the number of context data
  - getContextDataForCreation
```
public ArgumentContent getContextDataForCreation(int index)
```
    gets the type of context data for creation of an object with this property
    
    Parameters:
    
    index - an integer between 0 (included) and getDataInputSize (excluded)
    
    Returns:
    
    the context data at the given index
  - getDataInputSize
```
public int getDataInputSize()
```
    Returns:
    
    the number of data input fields for object creation
  - getDataInputForCreation
```
public ArgumentContent getDataInputForCreation(int index)
```
    gets the type of data input (argument content) for creation of an object with this property
    
    Parameters:
    
    index - an integer between 0 (included) and getDataInputSize (excluded)
    
    Returns:
    
    the argument content at the given index
  - addContextForDataCreation
```
protected void addContextForDataCreation(ArgumentContent contextdata)
```
    context for data creation is provided by the context. This will be the data passed to the object creation page
    
    Parameters:
    
    contextdata -
    
    optional - true if the context data is not obliged to be provided
  - isDataInputUsedForUpdate
```
public boolean isDataInputUsedForUpdate()
```
    data input argument can be shown on create (default) but also on update. This argument tells if the data input should be used on update page also
    
    Returns:
    
    true if data input argument(s) should be put on update page also
  - isDataInputHiddenForCreation
```
public boolean isDataInputHiddenForCreation()
```
    an indicator telling if data input should be hidden for creation (and so shown on update page only)
    
    Returns:
    
    true if data input should be hidden for creation
  - setDataInputForUpdate
```
protected void setDataInputForUpdate()
```
    will also use the data input for creation for the update of object
  - hideDataInputForCreation
```
protected void hideDataInputForCreation()
```
    will use the data input only for update
  - addDataInput
```
protected void addDataInput(ArgumentContent datainput)
```
    sets data input (by default for creation). This is typically entered by the user during the prepare creation page.
    
    Parameters:
    
    datainput - the data input.
  - getExternalObjectDependence
```
public abstract java.util.ArrayList<DataObjectDefinition> getExternalObjectDependence()
```
    Returns:
    
    a list of data object definitions that are linked to this property. This helps making necessary imports in the data object definition file
  - getChoiceCategoryNumber
```
public int getChoiceCategoryNumber()
```
    provides the number of choice categories used by this property. A choice category will 'type' the property with java generics
    
    Returns:
    
    the number of choice categories
  - getChoiceCategoryKeyNumber
```
public java.util.Iterator<java.lang.String> getChoiceCategoryKeyNumber()
```
    An iterator on choice categories used by this property. A choice category will 'type' the property with java generics
    
    Returns:
    
    iterator on choice categories
  - getChoiceCategoryByKey
```
public ChoiceCategory getChoiceCategoryByKey(java.lang.String key)
```
    gets the choice category by the given key
    
    Parameters:
    
    key - key provided by method getChoiceCategoryKeyNumber
    
    Returns:
    
    the corresponding choice category if exists, null else
  - getInstancename
```
public java.lang.String getInstancename()
```
    Returns:
    
    instance name, null if no specific instance name
  - addChoiceCategoryHelper
```
protected void addChoiceCategoryHelper(java.lang.String name,
                                       ChoiceCategory category)
```
    adds a choice category helper. THis means the property will have a generics linked to this choice category. E.g. The lifecycle property is defined by the choice of lifecycle states
    
    Parameters:
    
    name - name of the choice category
    
    category - choice category.
  - addStringHelper
```
protected void addStringHelper(java.lang.String name,
                               java.lang.String payload)
```
    A string helper is a string input defined when defining the property on a given object. It is used in Lifecycle to define a 'non-released' label that will be shown on a draft object
    
    Parameters:
    
    name - name of the string helper
    
    payload - default payload in the string helper
  - addObjectToAuthorityMapper
```
protected void addObjectToAuthorityMapper(java.lang.String name,
                                          ObjectToAuthorityMapper mapper)
```
    adds
    
    Parameters:
    
    name -
    
    mapper -
  - hasInterface
```
public boolean hasInterface()
```
    only properties that exist with only one instance can have an interface and so be referenced as significant property for the PropertyGenerics of anotherproperty
    
    Returns:
    
    true if the property will have an interface
  - getPropertyclassname
```
public java.lang.String getPropertyclassname()
```
    the property class name (different for the instance name in case the same property has several instances)
    
    Returns:
    
    the property class name
  - addDependentProperty
```
protected void addDependentProperty(Property<?> property)
```
    This defines a relation between the current property and the dependent property. This authorizes the following:
    - the current property can complete a method of the dependent property by adding pre or post treatment, through declaring a MethodAdditionalProcessing
    - the current property can access to data of the dependent property. This is offered through a reference to the dependent property inside the current property
    - a method of the current property can call a method of the dependent property
    Parameters:
    
    property - the dependent property
  - addDataAccessMethod
```
protected void addDataAccessMethod(DataAccessMethod dam)
```
    a data access method is a method defined by the property that will be available to the object for a business action
    
    Parameters:
    
    dam - data access method
  - addMethodAdditionalProcessing
```
protected void addMethodAdditionalProcessing(MethodAdditionalProcessing map)
```
    adds a method additional processing to a related property
    
    Parameters:
    
    map - method additional processing
  - getDataAccessMethodnumber
```
public int getDataAccessMethodnumber()
```
    Returns:
    
    the number of data access methods
  - getDataAccessMethod
```
public DataAccessMethod getDataAccessMethod(int index)
```
    get the data access method at the provided index
    
    Parameters:
    
    index - a number between 0 (included) and getDataAccessMethodNumber (excluded)
    
    Returns:
  - getMethodAdditionalProcessingnumber
```
public int getMethodAdditionalProcessingnumber()
```
    Returns:
    
    the number of method additional processings
  - getMethodAdditionalProcessing
```
public MethodAdditionalProcessing getMethodAdditionalProcessing(int index)
```
    get the method additional processing at the given index
    
    Parameters:
    
    index - a number between 0 (included) and getMethodAdditionalProcessingnumber (excluded)
    
    Returns:
  - getDataAccessMethod
```
public DataAccessMethod getDataAccessMethod(java.lang.String name)
```
    get data access method for the given name
    
    Parameters:
    
    name - name of the data access method
    
    Returns:
    
    the data access method if it exists
  - getParent
```
public DataObjectDefinition getParent()
```
    get the parent DataObjectDefinition for the property
    
    Returns:
    
    the parent DataObjectDefinition
  - addDisplayProfileForProperty
```
public void addDisplayProfileForProperty(DisplayProfile displayprofile)
```
    adds a display profile for this property. This allows, depending on context, to show different fields
    
    Parameters:
    
    displayprofile - display profile to add
  - getDisplayProfileForPropertyNumber
```
public int getDisplayProfileForPropertyNumber()
```
    gets the number of display profiles defined for this property
    
    Returns:
    
    number of display profiles
  - getDisplayProfileForProperty
```
public DisplayProfile getDisplayProfileForProperty(int index)
```
    gets the display profile at the given index
    
    Parameters:
    
    index - a number between 0 (included) and getDisplayProfileForPropertyNumber (excluded)
    
    Returns:
    
    the diplsay profile at the given index
  - addBusinessRule
```
public void addBusinessRule(PropertyBusinessRule<E> businessrule)
```
    Parameters:
    
    businessrule -
  - setDynamicDefinitionHelper
```
public void setDynamicDefinitionHelper()
```
    When a property has a dynamic definition helper, the definition helper has to be defined for each instance of the object.
  - hasDynamicDefinitionHelper
```
public boolean hasDynamicDefinitionHelper()
```
    Returns:
    
    true if the property has a dynamic definition helper
  - controlAfterParentDefinition
```
public void controlAfterParentDefinition()
```
    to be implemented if controls have to be performed after parent is added.
  - getFieldOverridesNumber
```
public int getFieldOverridesNumber()
```
    get the number of field overrides defined for the object
    
    Returns:
    
    number of field overrides
  - getFieldOverridesat
```
public FieldOverrideForProperty getFieldOverridesat(int index)
```
    gets the field override at the given index
    
    Parameters:
    
    index - a number between 0 (included) and getFieldOverridesNumber (excluded)
    
    Returns:
    
    the field override for the given index
  - addFieldOverrides
```
protected void addFieldOverrides(FieldOverrideForProperty override)
```
    adds a Field Overrides for the given property. It allows to change the label and priority of a field
    
    Parameters:
    
    override - a field overrides to add
  - hasStaticQuery
```
public boolean hasStaticQuery()
```
    Returns:
    
    true if the property has a static query amongst its methods
  - addPropertyGenerics
```
public void addPropertyGenerics(PropertyGenerics generics)
```
    adds a generics to the property. A generics is a reference to another object type than the parent data object
    
    Parameters:
    
    generics - the generics to add
  - getDependentProperties
```
public Property<?>[] getDependentProperties()
```
    this method should returns all properties this property is dependent on.
    
    Returns:
  - getDataObjectFieldName
```
public java.lang.String getDataObjectFieldName()
```
    Specified by:
    
    getDataObjectFieldName in class ObjectElement
    
    Returns:
    
    the unique name of the field
  - getDataObjectConstructorAttributes
```
public java.lang.String getDataObjectConstructorAttributes()
```
    Specified by:
    
    getDataObjectConstructorAttributes in class ObjectElement
    
    Returns:
    
    the attributes for the constructor to be used during code generation
  - isPropertyHelperTransient
```
public boolean isPropertyHelperTransient()
```
    Returns:
    
    true if the property has a transient property helper
  - getJavaClassType
```
public java.lang.String getJavaClassType()
```
    Returns:
    
    the java class name of the property
  - getPropertyGenericsSize
```
public int getPropertyGenericsSize()
```
    Returns:
    
    the number of generics of this objec
  - getPropertyGenericsString
```
public java.lang.String getPropertyGenericsString()
```
    Returns:
    
    the list of generics for the class declaration
  - getPropertyGenerics
```
public PropertyGenerics getPropertyGenerics(int index)
```
    gest the property generics at the given index
    
    Parameters:
    
    index - a number between 0 (included) and getPropertyGenericsSize (excluded)
    
    Returns:
    
    the property generics at the given index
  - addElement
```
public void addElement(Element e)
```
    adds a stored element to the property without any display or update setting
    
    Overrides:
    
    addElement in class ObjectElement
    
    Parameters:
    
    e - stored element
  - addElement
```
public void addElement(Element e,
                       java.lang.String display,
                       java.lang.String tooltip,
                       int fielddisplaymode,
                       int fielddisplaypriority,
                       int showcaractersintable)
```
    /** adds a stored element with display of the field specified
    
    Parameters:
    
    e - element to store
    
    display - display label
    
    tooltip - tooltip for roll-over mouse
    
    fielddisplaymode - the type of display as defined in the class PropertyElementDisplayDefinition
    
    fielddisplaypriority - priority display
    
    showcaractersintable - number of characters of width of the column
  - addElementasSearchElement
```
public void addElementasSearchElement(Element e,
                                      java.lang.String display,
                                      java.lang.String tooltip,
                                      int fielddisplaymode,
                                      int fielddisplaypriority,
                                      int showcaractersintable,
                                      SearchWidgetDefinition searchdef)
```
    adds a stored element with display of the field specified and the field appearing in field searches
    
    Parameters:
    
    e - element to store
    
    display - display label
    
    tooltip - tooltip for roll-over mouse
    
    fielddisplaymode - the type of display as defined in the class PropertyElementDisplayDefinition
    
    fielddisplaypriority - priority display
    
    showcaractersintable - number of characters of width of the column
    
    searchdef - definition of the search widget
  - getDisplayDefinitionForElement
```
public Property.PropertyElementDisplayDefinition getDisplayDefinitionForElement(Element e)
```
    gets the display definition for a given element of the property
    
    Parameters:
    
    e - element
    
    Returns:
    
    the display information if it exists
  - setFinalSettings
```
public abstract void setFinalSettings()
```
    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 )
  - isLegacy
```
public boolean isLegacy()
```
    Returns:
    
    true if the property is legacy, meaning it is still present to perform a migration, but not shown. Business logic is deactivated, but data is still accessible.
  - setAsLegacy
```
protected void setAsLegacy()
```
    sets this property as legacy
  - getPropertyHelperName
```
public java.lang.String getPropertyHelperName()
```
    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
    
    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
```
    Generates in the data folder the property helper.
    
    Parameters:
    
    sg - source generator
    
    module - parent module
    
    Throws:
    
    java.io.IOException - if any error is encountered writing the source file
  - writeAdditionalDefinition
```
public void writeAdditionalDefinition(SourceGenerator sg)
                               throws java.io.IOException
```
    This method allows a property to define extra conditions when writing additional definition on the property
    
    Parameters:
    
    sg - source generator
    
    Throws:
    
    java.io.IOException - if any error is encountered writing the source file

Class Property<E extends Property<E>>

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

parent

FIELDDISPLAY_NONE

FIELDDISPLAY_BOTTOMNOTES

FIELDDISPLAY_NORMAL

FIELDDISPLAY_NORMAL_MOD

FIELDDISPLAY_TITLE

FIELDDIPLSAY_TITLE_MOD

Constructor Detail

Property

Property

Method Detail

isDatainputatbottom

setDatainputatbottom

setExtraAttributes

addExternalObjectProperty

getExternalObjectPropertySize

getExternalObject

getExternalObjectProperty

getBusinessRuleNumber

getBusinessRule

getBusinessRuleByName

getPropertyInitMethod

getPropertyExtractMethod

getPropertyDeepCopyStatement

getContextDataForCreationSize

getContextDataForCreation

getDataInputSize

getDataInputForCreation

addContextForDataCreation

isDataInputUsedForUpdate

isDataInputHiddenForCreation

setDataInputForUpdate

hideDataInputForCreation

addDataInput

getExternalObjectDependence

getChoiceCategoryNumber

getChoiceCategoryKeyNumber

getChoiceCategoryByKey

getInstancename

addChoiceCategoryHelper

addStringHelper

addObjectToAuthorityMapper

hasInterface

getPropertyclassname

addDependentProperty

addDataAccessMethod

addMethodAdditionalProcessing

getDataAccessMethodnumber

getDataAccessMethod

getMethodAdditionalProcessingnumber

getMethodAdditionalProcessing

getDataAccessMethod

getParent

addDisplayProfileForProperty

getDisplayProfileForPropertyNumber

getDisplayProfileForProperty

addBusinessRule

setDynamicDefinitionHelper

hasDynamicDefinitionHelper

controlAfterParentDefinition

getFieldOverridesNumber

getFieldOverridesat

addFieldOverrides

hasStaticQuery

addPropertyGenerics

getDependentProperties

getDataObjectFieldName

getDataObjectConstructorAttributes

isPropertyHelperTransient

getJavaClassType

getPropertyGenericsSize