TimeslotwithsessionsDefinition

java.lang.Object
- org.openlowcode.tools.misc.Named
- - org.openlowcode.server.data.DataObjectElementDefinition<FieldSchema,E>
  - - org.openlowcode.server.data.DataObjectPropertyDefinition<E>
    - - org.openlowcode.server.data.properties.TimeslotwithsessionsDefinition<E,F>

Type Parameters:

E - The timeslot object (total calendar period for an activity

F - the session object. A child of the timeslot, it stores any precise session

All Implemented Interfaces:

NamedInterface
```
public class TimeslotwithsessionsDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E> & TimeslotInterface<E> & ScheduleInterface<E,?>,F extends DataObject<F> & SessionInterface<F,E> & UniqueidentifiedInterface<F>>
extends DataObjectPropertyDefinition<E>
```
definition of the timeslot with session property. This property is added on the timeslot object to mean it has detailed sessions

Author:

Open Lowcode SAS

Nested Class Summary
- Nested classes/interfaces inherited from class org.openlowcode.server.data.DataObjectPropertyDefinition
  DataObjectPropertyDefinition.ExternalFieldByJoinQuery, DataObjectPropertyDefinition.FieldSchemaForDisplay<E extends DataObject<E>>

Field Summary
- Fields inherited from class org.openlowcode.server.data.DataObjectPropertyDefinition
  allexternalfields, externalfieldsbyjoinquery, parentobject

Constructor Summary

Constructors
Constructor and Description
`TimeslotwithsessionsDefinition(DataObjectDefinition<E> parentobject, DataObjectDefinition<F> childsessiondefinition)` creates the property definition

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.ArrayList<ExternalFieldSchema<?>>`	`generateExternalSchema()`
`SessionDefinition<F,E>`	`getChildrenSessionDefinition()`
`FlatFileLoaderColumn<E>`	`getFlatFileLoaderColumn(DataObjectDefinition<E> objectdefinition, java.lang.String[] columnattributes, PropertyExtractor<E> propertyextractor, ChoiceValue<ApplocaleChoiceDefinition> locale)` generates the flat file loader for this property
`java.lang.String[]`	`getLoaderFieldList()`
`java.lang.String[]`	`getLoaderFieldSample(java.lang.String name)`
`UniqueidentifiedDefinition<E>`	`getUniqueIdentifiedDefinition()`
`QueryCondition`	`getUniversalQueryCondition(java.lang.String alias)` each property can define query conditions to be applied by all other properties on an object.
`DataObjectElement`	`initiateFieldInstance(DataObjectPayload parentpayload)`
`void`	`setDependentDefinitionSchedule(ScheduleDefinition<E,?> scheduledefinition)` sets the dependent property schedule definition
`void`	`setDependentDefinitionUniqueidentified(UniqueidentifiedDefinition<E> uniqueidentified)` sets dependent property unique identified
`DataObjectPropertyDefinition.FieldSchemaForDisplay<E>[]`	`setFieldSchemaToDisplay()` each property should define the list of fields to display as read-only fields of the object.
`void`	`setGenericsChildrensessionsProperty(SessionDefinition<F,E> childrensessionpropertydefinition)` sets the session definition on the child object

Methods inherited from class org.openlowcode.server.data.DataObjectPropertyDefinition
addStoredFieldSchema, getAllExternalFields, getDataObjectFieldDefinition, getExternalFieldsByJoinQueries, getFieldMarker, getParentObject, getTransientLoaderHelper, initiateExternalFieldSchema

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
  - TimeslotwithsessionsDefinition
```
public TimeslotwithsessionsDefinition(DataObjectDefinition<E> parentobject,
                                      DataObjectDefinition<F> childsessiondefinition)
```
    creates the property definition
    
    Parameters:
    
    parentobject - parent object definition
    
    childsessiondefinition - child session definition
- Method Detail
  - getUniqueIdentifiedDefinition
```
public UniqueidentifiedDefinition<E> getUniqueIdentifiedDefinition()
```
    Returns:
    
    the unique identified definition for this object
  - getChildrenSessionDefinition
```
public SessionDefinition<F,E> getChildrenSessionDefinition()
```
    Returns:
    
    the definition of the property session on the session child object
  - setDependentDefinitionSchedule
```
public void setDependentDefinitionSchedule(ScheduleDefinition<E,?> scheduledefinition)
```
    sets the dependent property schedule definition
    
    Parameters:
    
    scheduledefinition - schedule definition
  - setGenericsChildrensessionsProperty
```
public void setGenericsChildrensessionsProperty(SessionDefinition<F,E> childrensessionpropertydefinition)
```
    sets the session definition on the child object
    
    Parameters:
    
    childrensessionpropertydefinition - session definition on the child object
  - generateExternalSchema
```
public java.util.ArrayList<ExternalFieldSchema<?>> generateExternalSchema()
```
    Specified by:
    
    generateExternalSchema in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E> & TimeslotInterface<E> & ScheduleInterface<E,?>>
    
    Returns:
    
    get all external fields
  - getUniversalQueryCondition
```
public QueryCondition getUniversalQueryCondition(java.lang.String alias)
```
    Description copied from class: DataObjectPropertyDefinition
    
    each property can define query conditions to be applied by all other properties on an object. THis is mostly for properties that archive copy of the object in the table.
    
    Specified by:
    
    getUniversalQueryCondition in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E> & TimeslotInterface<E> & ScheduleInterface<E,?>>
    
    Parameters:
    
    alias - alias for which the query condition should be created;
    
    Returns:
    
    the query condition to apply or null if this property does not require one.
  - setFieldSchemaToDisplay
```
public DataObjectPropertyDefinition.FieldSchemaForDisplay<E>[] setFieldSchemaToDisplay()
```
    Description copied from class: DataObjectPropertyDefinition
    
    each property should define the list of fields to display as read-only fields of the object. All FieldSchemas referenced here should be the property own field schemas, else an exception will be thrown
    
    Specified by:
    
    setFieldSchemaToDisplay in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E> & TimeslotInterface<E> & ScheduleInterface<E,?>>
    
    Returns:
  - getFlatFileLoaderColumn
```
public FlatFileLoaderColumn<E> getFlatFileLoaderColumn(DataObjectDefinition<E> objectdefinition,
                                                       java.lang.String[] columnattributes,
                                                       PropertyExtractor<E> propertyextractor,
                                                       ChoiceValue<ApplocaleChoiceDefinition> locale)
```
    Description copied from class: DataObjectPropertyDefinition
    
    generates the flat file loader for this property
    
    Specified by:
    
    getFlatFileLoaderColumn in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E> & TimeslotInterface<E> & ScheduleInterface<E,?>>
    
    Parameters:
    
    objectdefinition - definition of the object
    
    columnattributes - column attributes
    
    propertyextractor - an extractor providing this property from the object
    
    locale - locale if loaded by CSV
    
    Returns:
    
    a flat file loader
  - getLoaderFieldList
```
public java.lang.String[] getLoaderFieldList()
```
    Specified by:
    
    getLoaderFieldList in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E> & TimeslotInterface<E> & ScheduleInterface<E,?>>
    
    Returns:
    
    a list of fields for the property
  - getLoaderFieldSample
```
public java.lang.String[] getLoaderFieldSample(java.lang.String name)
```
    Specified by:
    
    getLoaderFieldSample in class DataObjectPropertyDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E> & TimeslotInterface<E> & ScheduleInterface<E,?>>
    
    Parameters:
    
    name - name as returned by the function getLoaderFieldList
    
    Returns:
    an array of 4 strings
    
    full name of the field
    
    OPTIONAL or MANDATORY
    
    Sample Values
    
    Comments including options
  - initiateFieldInstance
```
public DataObjectElement initiateFieldInstance(DataObjectPayload parentpayload)
```
    Specified by:
    
    initiateFieldInstance in class DataObjectElementDefinition<FieldSchema,E extends DataObject<E> & UniqueidentifiedInterface<E> & TimeslotInterface<E> & ScheduleInterface<E,?>>
    
    Parameters:
    
    parentpayload - the object payload
    
    Returns:
    
    an element corresponding to this element initiated with the information in the object payload
  - setDependentDefinitionUniqueidentified
```
public void setDependentDefinitionUniqueidentified(UniqueidentifiedDefinition<E> uniqueidentified)
```
    sets dependent property unique identified
    
    Parameters:
    
    uniqueidentified - dependent property unique identified

Class TimeslotwithsessionsDefinition<E extends DataObject<E> & UniqueidentifiedInterface<E> & TimeslotInterface<E> & ScheduleInterface<E,?>,F extends DataObject<F> & SessionInterface<F,E> & UniqueidentifiedInterface<F>>

Nested Class Summary

Nested classes/interfaces inherited from class org.openlowcode.server.data.DataObjectPropertyDefinition

Field Summary

Fields inherited from class org.openlowcode.server.data.DataObjectPropertyDefinition

Constructor Summary

Method Summary

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

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

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

Methods inherited from class java.lang.Object

Constructor Detail

TimeslotwithsessionsDefinition

Method Detail

getUniqueIdentifiedDefinition

getChildrenSessionDefinition

setDependentDefinitionSchedule

setGenericsChildrensessionsProperty

generateExternalSchema

getUniversalQueryCondition

setFieldSchemaToDisplay

getFlatFileLoaderColumn

getLoaderFieldList

getLoaderFieldSample

initiateFieldInstance

setDependentDefinitionUniqueidentified