org.openlowcode.server.data

Class TimePeriodDataObjectFieldDefinition<E extends DataObject<E>>

java.lang.Object

org.openlowcode.tools.misc.Named

org.openlowcode.server.data.DataObjectElementDefinition<StoredFieldSchema,E>

org.openlowcode.server.data.DataObjectFieldDefinition<E>

org.openlowcode.server.data.TimePeriodDataObjectFieldDefinition<E>

Type Parameters:

E - data object the field is on

All Implemented Interfaces:

NamedInterface

public class TimePeriodDataObjectFieldDefinition<E extends DataObject<E>>
extends DataObjectFieldDefinition<E>

Definition of a time period data object field

Author:

Open Lowcode SAS

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimePeriodDataObjectFieldDefinition.TimePeriodFormatter a class allowing to decode a time period from the string stored value

Constructor Summary

Constructors

Constructor and Description
TimePeriodDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, boolean readonly, TimePeriod.PeriodType periodtype, DataObjectDefinition<E> definition) Creates a data object field
TimePeriodDataObjectFieldDefinition(java.lang.String name, java.lang.String displayname, java.lang.String tooltip, boolean readonly, TimePeriod.PeriodType periodtype, int priority, DataObjectDefinition<E> definition)

Method Summary

Modifier and Type	Method and Description
SPageNode	getDataFieldDefinition()
FlatFileLoaderColumn<E>	getFlatFileLoaderColumn(DataObjectDefinition<E> objectdefinition, java.lang.String[] columnattributes, ChoiceValue<ApplocaleChoiceDefinition> locale) generates the flat file loader for this property
java.lang.String[]	getLoaderFieldSample()
StoredFieldSchema<?>	getMainStoredField()
DataObjectElement	initiateFieldInstance(DataObjectPayload parentpayload)

Methods inherited from class org.openlowcode.server.data.DataObjectFieldDefinition

getDefaultcolumnintable, getDisplayname, getObjectDefinition, getPriority, getTooltip, isReadOnly, isShowinbottonpage, isShowintitle

Methods inherited from class org.openlowcode.server.data.DataObjectElementDefinition

addFieldSchema, addIndex, dropfieldnamelist, getDefinition, getFieldSchema, getFieldSchemaByName, getFieldSchemaNumber, getIndexAt, getIndexNumber, getTriggerlist, isFormulaElement, setTriggerOnUpdate

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

TimePeriodDataObjectFieldDefinition

public TimePeriodDataObjectFieldDefinition(java.lang.String name,
                                           java.lang.String displayname,
                                           java.lang.String tooltip,
                                           boolean readonly,
                                           TimePeriod.PeriodType periodtype,
                                           DataObjectDefinition<E> definition)

Creates a data object field

Parameters:

name - unique name of the field (without special character, space...)

displayname - display name for the field in the default language

tooltip - a long tooltip display when rolling-over

readonly - readonly if field is not modifiable by the user

periodtype - type of TimePeriod (Year, Quarter, Month...)

definition - definition of the parent object

TimePeriodDataObjectFieldDefinition

public TimePeriodDataObjectFieldDefinition(java.lang.String name,
                                           java.lang.String displayname,
                                           java.lang.String tooltip,
                                           boolean readonly,
                                           TimePeriod.PeriodType periodtype,
                                           int priority,
                                           DataObjectDefinition<E> definition)

Parameters:

name - unique name of the field (without special character, space...)

displayname - display name for the field in the default language

tooltip - a long tooltip display when rolling-over

readonly - readonly if field is not modifiable by the user

periodtype - type of TimePeriod (Year, Quarter, Month...)

priority - priority of the field for client display between -1000 (low) and 1000 (high)

definition - definition of the parent object

Method Detail

getDataFieldDefinition

public SPageNode getDataFieldDefinition()

Specified by:

getDataFieldDefinition in class DataObjectFieldDefinition<E extends DataObject<E>>

Returns:

the widget to use for display in object

getFlatFileLoaderColumn

public FlatFileLoaderColumn<E> getFlatFileLoaderColumn(DataObjectDefinition<E> objectdefinition,
                                                       java.lang.String[] columnattributes,
                                                       ChoiceValue<ApplocaleChoiceDefinition> locale)

Description copied from class: DataObjectFieldDefinition

generates the flat file loader for this property

Specified by:

getFlatFileLoaderColumn in class DataObjectFieldDefinition<E extends DataObject<E>>

Parameters:

objectdefinition - definition of the object

columnattributes - column attributes

locale - locale if loaded by CSV

Returns:

a flat file loader

getLoaderFieldSample

public java.lang.String[] getLoaderFieldSample()

Specified by:

getLoaderFieldSample in class DataObjectFieldDefinition<E extends DataObject<E>>

Returns:

an array of 4 strings

• full name of the field
• OPTIONAL or MANDATORY
• Sample Values
• Comments including options

getMainStoredField

public StoredFieldSchema<?> getMainStoredField()

Specified by:

getMainStoredField in class DataObjectFieldDefinition<E extends DataObject<E>>

Returns:

the default stored field schema used when searching on this field

initiateFieldInstance

public DataObjectElement initiateFieldInstance(DataObjectPayload parentpayload)

Specified by:

initiateFieldInstance in class DataObjectElementDefinition<StoredFieldSchema,E extends DataObject<E>>

Parameters:

parentpayload - the object payload

Returns:

an element corresponding to this element initiated with the information in the object payload