EntityModel (Dynamo Framework - API 1.6.3-CB3 API)

Type Parameters:

T - the type of the entity
```
public interface EntityModel<T>
```
An interface representing a model that contains an entity's metadata

Author:

bas.rutten

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALLOWED_EXTENSIONS` Allowed extensions (for a file upload)
`static String`	`ATTRIBUTE_GROUP` Used to define an attribute group in the message bundle
`static String`	`ATTRIBUTE_NAMES` Attribute names
`static String`	`ATTRIBUTE_ORDER` Attribute order
`static String`	`CASCADE` Cascade attribute
`static String`	`CASCADE_FILTER_PATH` Cascade filter path (what to filter to receving end of the cascade on)
`static String`	`CASCADE_MODE` Cascade mode (when to apply cascading - search, edit, or both)
`static String`	`CASCADE_OFF` To completely turn off cascading for an attribute
`static String`	`CHECKBOX_MODE` The "checkbox mode" for a boolean (either a checkbox or a toggle)
`static String`	`COMPLEX_EDITABLE` Whether the attribute (of type MASTER, DETAIL or ELEMENT_TABLE) can be edited in an edit form
`static String`	`CURRENCY` Whether an amount represents a currency
`static String`	`DATE_TYPE` The date type (date, time, or time stamp) of a value of type java.util.Date
`static String`	`DEFAULT_GROUP` The name of the default group for all attributes for which no explicit group is specified
`static String`	`DEFAULT_VALUE` Default value when creating new entity
`static String`	`DESCRIPTION` Description (used for tool tip)
`static String`	`DIRECT_NAVIGATION` Indicates whether direct navigation to this linked entity is allowed
`static String`	`DISPLAY_FORMAT` Display format for date, time, or time stamp fields
`static String`	`DISPLAY_NAME` Display name (used as title/caption)
`static String`	`DISPLAY_NAME_PLURAL` Display name plural form (used as title above tables/lists)
`static String`	`DISPLAY_PROPERTY` The display property (used to determine what to display when using the entity inside a lookup component or inside a table)
`static String`	`EDITABLE` The editable modus (EDITABLE, READ_ONLY, or CREATE_ONLY)
`static String`	`EMBEDDED` Whether the property is embedded
`static String`	`FALSE_REPRESENTATION` The String representation for the boolean "false" value
`static String`	`GROUP_TOGETHER_WITH` Names of other attributes that must appear on the same line inside an edit form
`static String`	`IMAGE` Whether a field represents an image
`static String`	`MAIN` Whether the attribute is the main attribute
`static String`	`MAX_LENGTH` The maximum length of the items inside an element collection
`static String`	`MAX_LENGTH_IN_TABLE` The maximum string length of the textual representation inside a table
`static String`	`MAX_VALUE` The maximum value of the numeric items inside an element collection
`static String`	`MESSAGE_KEY` Message key
`static String`	`MIN_LENGTH` The minimum length of the numeric items inside an element collection
`static String`	`MIN_VALUE` The minimum value of the items inside an element collection
`static String`	`MULTIPLE_SEARCH` Whether to allow searching for multiple values in case of a MASTER attribute
`static String`	`NAVIGABLE` Whether a link in a table is navigable
`static String`	`NUMBER_SELECT_MODE` Type of number input field to use instead of a text field
`static String`	`PERCENTAGE` Whether to include a percentage sign to a numerical field (cosmetic only)
`static String`	`PRECISION` The decimal precision
`static String`	`PROMPT` The prompt value that appears inside empty input fields
`static String`	`QUICK_ADD_PROPERTY` Indicates that quick add functionality is enabled
`static String`	`READ_ONLY` Indicates whether the property is read-only.
`static String`	`REPLACEMENT_SEARCH_PATH` The path to actually search for (replaces the standard search path)
`static String`	`REQUIRED_FOR_SEARCHING` Whether this attribute is required when performing a search
`static String`	`SEARCH_CASE_SENSITIVE` Whether searching is case sensivite
`static String`	`SEARCH_EXACT_VALUE` Whether to search for exact values (in case of numbers and dates)
`static String`	`SEARCH_PREFIX_ONLY` Whether to only search on prefix values
`static String`	`SEARCH_SELECT_MODE` The select mode in a search screen
`static String`	`SEARCHABLE` Whether the field is searchable
`static String`	`SELECT_MODE` Indicates that a lookup field (rather than a combo box) must be used when selecting the component
`static String`	`SHOW_IN_TABLE` Whether to show an attribute inside a table
`static String`	`SORT_ORDER` Default sort order for an entity
`static String`	`SORTABLE` Whether it is possible to sort on an attribute
`static String`	`STYLES` One or more styles for the field
`static String`	`TEXTFIELD_MODE` The text field mode - indicates whether to use a text field or text area for editing a String field
`static String`	`THOUSANDS_GROUPING` Indicates whether to use thousand grouping characters in view mode
`static String`	`TRUE_REPRESENTATION` The textual representation of the boolean "TRUE" value
`static String`	`URL` Indicates that a value must be represented in a table as a clickable URL
`static String`	`VISIBLE` Indicated whether the field is visible
`static String`	`WEEK` Indicates whether to format a date field as a week code

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addAttributeGroup(String attributeGroup)`
`void`	`addAttributeModel(String attributeGroup, AttributeModel model, AttributeModel existingModel)` Adds a new attribute model on the position of the given existing attribute model.
`List<String>`	`getAttributeGroups()` Returns the attribute groups that are defined for this entity
`AttributeModel`	`getAttributeModel(String attributeName)` Looks up an attribute model by its name
`List<AttributeModel>`	`getAttributeModels()` Returns an ordered list of all attribute models
`List<AttributeModel>`	`getAttributeModelsForGroup(String group)` Returns the attribute models for a certain group
`List<AttributeModel>`	`getAttributeModelsForType(AttributeType attributeType, Class<?> type)` Returns the attribute models for a certain attribute type and type.
`List<AttributeModel>`	`getCascadeAttributeModels()`
`String`	`getDescription()` Textual description of the entity
`String`	`getDisplayName()` The display name of the entity
`String`	`getDisplayNamePlural()` The display name (plural) of the entity
`String`	`getDisplayProperty()` The name of the property that is used when displaying the entity inside a select component (like a combo box) or a table
`Class<T>`	`getEntityClass()` The class of the entity that this model is based on
`AttributeModel`	`getIdAttributeModel()`
`AttributeModel`	`getMainAttributeModel()` Returns the main attribute
`String`	`getReference()`
`List<AttributeModel>`	`getRequiredForSearchingAttributeModels()`
`Map<AttributeModel,Boolean>`	`getSortOrder()` Get the default sort order
`boolean`	`isAttributeGroupVisible(String group, boolean readOnly)` Indicates whether an attribute group should be visible
`boolean`	`usesDefaultGroupOnly()`

- Field Detail
  - ALLOWED_EXTENSIONS
```
static final String ALLOWED_EXTENSIONS
```
    Allowed extensions (for a file upload)
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_GROUP
```
static final String ATTRIBUTE_GROUP
```
    Used to define an attribute group in the message bundle
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_NAMES
```
static final String ATTRIBUTE_NAMES
```
    Attribute names
    
    See Also:
    
    Constant Field Values
  - ATTRIBUTE_ORDER
```
static final String ATTRIBUTE_ORDER
```
    Attribute order
    
    See Also:
    
    Constant Field Values
  - CASCADE
```
static final String CASCADE
```
    Cascade attribute
    
    See Also:
    
    Constant Field Values
  - CASCADE_OFF
```
static final String CASCADE_OFF
```
    To completely turn off cascading for an attribute
    
    See Also:
    
    Constant Field Values
  - CASCADE_FILTER_PATH
```
static final String CASCADE_FILTER_PATH
```
    Cascade filter path (what to filter to receving end of the cascade on)
    
    See Also:
    
    Constant Field Values
  - CASCADE_MODE
```
static final String CASCADE_MODE
```
    Cascade mode (when to apply cascading - search, edit, or both)
    
    See Also:
    
    Constant Field Values
  - CHECKBOX_MODE
```
static final String CHECKBOX_MODE
```
    The "checkbox mode" for a boolean (either a checkbox or a toggle)
    
    See Also:
    
    Constant Field Values
  - COMPLEX_EDITABLE
```
static final String COMPLEX_EDITABLE
```
    Whether the attribute (of type MASTER, DETAIL or ELEMENT_TABLE) can be edited in an edit form
    
    See Also:
    
    Constant Field Values
  - CURRENCY
```
static final String CURRENCY
```
    Whether an amount represents a currency
    
    See Also:
    
    Constant Field Values
  - DATE_TYPE
```
static final String DATE_TYPE
```
    The date type (date, time, or time stamp) of a value of type java.util.Date
    
    See Also:
    
    Constant Field Values
  - DEFAULT_GROUP
```
static final String DEFAULT_GROUP
```
    The name of the default group for all attributes for which no explicit group is specified
    
    See Also:
    
    Constant Field Values
  - DEFAULT_VALUE
```
static final String DEFAULT_VALUE
```
    Default value when creating new entity
    
    See Also:
    
    Constant Field Values
  - DESCRIPTION
```
static final String DESCRIPTION
```
    Description (used for tool tip)
    
    See Also:
    
    Constant Field Values
  - DISPLAY_FORMAT
```
static final String DISPLAY_FORMAT
```
    Display format for date, time, or time stamp fields
    
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME
```
static final String DISPLAY_NAME
```
    Display name (used as title/caption)
    
    See Also:
    
    Constant Field Values
  - DISPLAY_NAME_PLURAL
```
static final String DISPLAY_NAME_PLURAL
```
    Display name plural form (used as title above tables/lists)
    
    See Also:
    
    Constant Field Values
  - DISPLAY_PROPERTY
```
static final String DISPLAY_PROPERTY
```
    The display property (used to determine what to display when using the entity inside a lookup component or inside a table)
    
    See Also:
    
    Constant Field Values
  - EMBEDDED
```
static final String EMBEDDED
```
    Whether the property is embedded
    
    See Also:
    
    Constant Field Values
  - FALSE_REPRESENTATION
```
static final String FALSE_REPRESENTATION
```
    The String representation for the boolean "false" value
    
    See Also:
    
    Constant Field Values
  - GROUP_TOGETHER_WITH
```
static final String GROUP_TOGETHER_WITH
```
    Names of other attributes that must appear on the same line inside an edit form
    
    See Also:
    
    Constant Field Values
  - IMAGE
```
static final String IMAGE
```
    Whether a field represents an image
    
    See Also:
    
    Constant Field Values
  - MAIN
```
static final String MAIN
```
    Whether the attribute is the main attribute
    
    See Also:
    
    Constant Field Values
  - MAX_LENGTH
```
static final String MAX_LENGTH
```
    The maximum length of the items inside an element collection
    
    See Also:
    
    Constant Field Values
  - MAX_LENGTH_IN_TABLE
```
static final String MAX_LENGTH_IN_TABLE
```
    The maximum string length of the textual representation inside a table
    
    See Also:
    
    Constant Field Values
  - MAX_VALUE
```
static final String MAX_VALUE
```
    The maximum value of the numeric items inside an element collection
    
    See Also:
    
    Constant Field Values
  - MESSAGE_KEY
```
static final String MESSAGE_KEY
```
    Message key
    
    See Also:
    
    Constant Field Values
  - MIN_LENGTH
```
static final String MIN_LENGTH
```
    The minimum length of the numeric items inside an element collection
    
    See Also:
    
    Constant Field Values
  - MIN_VALUE
```
static final String MIN_VALUE
```
    The minimum value of the items inside an element collection
    
    See Also:
    
    Constant Field Values
  - MULTIPLE_SEARCH
```
static final String MULTIPLE_SEARCH
```
    Whether to allow searching for multiple values in case of a MASTER attribute
    
    See Also:
    
    Constant Field Values
  - NAVIGABLE
```
static final String NAVIGABLE
```
    Whether a link in a table is navigable
    
    See Also:
    
    Constant Field Values
  - PERCENTAGE
```
static final String PERCENTAGE
```
    Whether to include a percentage sign to a numerical field (cosmetic only)
    
    See Also:
    
    Constant Field Values
  - PRECISION
```
static final String PRECISION
```
    The decimal precision
    
    See Also:
    
    Constant Field Values
  - PROMPT
```
static final String PROMPT
```
    The prompt value that appears inside empty input fields
    
    See Also:
    
    Constant Field Values
  - QUICK_ADD_PROPERTY
```
static final String QUICK_ADD_PROPERTY
```
    Indicates that quick add functionality is enabled
    
    See Also:
    
    Constant Field Values
  - READ_ONLY
```
static final String READ_ONLY
```
    Indicates whether the property is read-only. This is deprecated but left for convenience - please use "editable" instead
    
    See Also:
    
    Constant Field Values
  - EDITABLE
```
static final String EDITABLE
```
    The editable modus (EDITABLE, READ_ONLY, or CREATE_ONLY)
    
    See Also:
    
    Constant Field Values
  - REPLACEMENT_SEARCH_PATH
```
static final String REPLACEMENT_SEARCH_PATH
```
    The path to actually search for (replaces the standard search path)
    
    See Also:
    
    Constant Field Values
  - REQUIRED_FOR_SEARCHING
```
static final String REQUIRED_FOR_SEARCHING
```
    Whether this attribute is required when performing a search
    
    See Also:
    
    Constant Field Values
  - SEARCH_CASE_SENSITIVE
```
static final String SEARCH_CASE_SENSITIVE
```
    Whether searching is case sensivite
    
    See Also:
    
    Constant Field Values
  - SEARCH_EXACT_VALUE
```
static final String SEARCH_EXACT_VALUE
```
    Whether to search for exact values (in case of numbers and dates)
    
    See Also:
    
    Constant Field Values
  - SEARCH_PREFIX_ONLY
```
static final String SEARCH_PREFIX_ONLY
```
    Whether to only search on prefix values
    
    See Also:
    
    Constant Field Values
  - SEARCH_SELECT_MODE
```
static final String SEARCH_SELECT_MODE
```
    The select mode in a search screen
    
    See Also:
    
    Constant Field Values
  - SEARCHABLE
```
static final String SEARCHABLE
```
    Whether the field is searchable
    
    See Also:
    
    Constant Field Values
  - STYLES
```
static final String STYLES
```
    One or more styles for the field
    
    See Also:
    
    Constant Field Values
  - SELECT_MODE
```
static final String SELECT_MODE
```
    Indicates that a lookup field (rather than a combo box) must be used when selecting the component
    
    See Also:
    
    Constant Field Values
  - NUMBER_SELECT_MODE
```
static final String NUMBER_SELECT_MODE
```
    Type of number input field to use instead of a text field
    
    See Also:
    
    Constant Field Values
  - SHOW_IN_TABLE
```
static final String SHOW_IN_TABLE
```
    Whether to show an attribute inside a table
    
    See Also:
    
    Constant Field Values
  - SORT_ORDER
```
static final String SORT_ORDER
```
    Default sort order for an entity
    
    See Also:
    
    Constant Field Values
  - SORTABLE
```
static final String SORTABLE
```
    Whether it is possible to sort on an attribute
    
    See Also:
    
    Constant Field Values
  - TEXTFIELD_MODE
```
static final String TEXTFIELD_MODE
```
    The text field mode - indicates whether to use a text field or text area for editing a String field
    
    See Also:
    
    Constant Field Values
  - THOUSANDS_GROUPING
```
static final String THOUSANDS_GROUPING
```
    Indicates whether to use thousand grouping characters in view mode
    
    See Also:
    
    Constant Field Values
  - TRUE_REPRESENTATION
```
static final String TRUE_REPRESENTATION
```
    The textual representation of the boolean "TRUE" value
    
    See Also:
    
    Constant Field Values
  - URL
```
static final String URL
```
    Indicates that a value must be represented in a table as a clickable URL
    
    See Also:
    
    Constant Field Values
  - VISIBLE
```
static final String VISIBLE
```
    Indicated whether the field is visible
    
    See Also:
    
    Constant Field Values
  - WEEK
```
static final String WEEK
```
    Indicates whether to format a date field as a week code
    
    See Also:
    
    Constant Field Values
  - DIRECT_NAVIGATION
```
static final String DIRECT_NAVIGATION
```
    Indicates whether direct navigation to this linked entity is allowed
    
    See Also:
    
    Constant Field Values
- Method Detail
  - addAttributeGroup
```
void addAttributeGroup(String attributeGroup)
```
  - addAttributeModel
```
void addAttributeModel(String attributeGroup,
                       AttributeModel model,
                       AttributeModel existingModel)
```
    Adds a new attribute model on the position of the given existing attribute model. The existing model will shift one position to the back of the list. When the existing model is not found the attribute will added on the end of the list.
    
    Parameters:
    
    attributeGroup - The group to which the attribute model should be registered
    
    model - The model of the attribute
    
    existingModel - The existing attribute model
  - getAttributeGroups
```
List<String> getAttributeGroups()
```
    Returns the attribute groups that are defined for this entity
    
    Returns:
  - getAttributeModel
```
AttributeModel getAttributeModel(String attributeName)
```
    Looks up an attribute model by its name
    
    Parameters:
    
    attributeName - the name of the attribute
    
    Returns:
  - getAttributeModels
```
List<AttributeModel> getAttributeModels()
```
    Returns an ordered list of all attribute models
    
    Returns:
  - getAttributeModelsForGroup
```
List<AttributeModel> getAttributeModelsForGroup(String group)
```
    Returns the attribute models for a certain group
    
    Parameters:
    
    group - the caption of the group
    
    Returns:
  - getAttributeModelsForType
```
List<AttributeModel> getAttributeModelsForType(AttributeType attributeType,
                                               Class<?> type)
```
    Returns the attribute models for a certain attribute type and type. Just one of the parameters is mandatory, when both are given both will be used in a boolean AND. Will also look at the generic type of a attribute, e.g. List.
    
    Parameters:
    
    attributeType -
    
    type -
    
    Returns:
  - getCascadeAttributeModels
```
List<AttributeModel> getCascadeAttributeModels()
```
    Returns:
    
    the attribute models for which cascading has been defined
  - getDescription
```
String getDescription()
```
    Textual description of the entity
    
    Returns:
  - getDisplayName
```
String getDisplayName()
```
    The display name of the entity
    
    Returns:
  - getDisplayNamePlural
```
String getDisplayNamePlural()
```
    The display name (plural) of the entity
    
    Returns:
  - getDisplayProperty
```
String getDisplayProperty()
```
    The name of the property that is used when displaying the entity inside a select component (like a combo box) or a table
    
    Returns:
  - getEntityClass
```
Class<T> getEntityClass()
```
    The class of the entity that this model is based on
    
    Returns:
  - getIdAttributeModel
```
AttributeModel getIdAttributeModel()
```
    Returns:
    
    The attribute model of the id
  - getMainAttributeModel
```
AttributeModel getMainAttributeModel()
```
    Returns the main attribute
    
    Returns:
  - getReference
```
String getReference()
```
  - getRequiredForSearchingAttributeModels
```
List<AttributeModel> getRequiredForSearchingAttributeModels()
```
    Returns:
    
    all attribute models for all attributes that are required for searching
  - getSortOrder
```
Map<AttributeModel,Boolean> getSortOrder()
```
    Get the default sort order
    
    Returns:
    
    a map of attribute models for which sort orders are set
  - isAttributeGroupVisible
```
boolean isAttributeGroupVisible(String group,
                                boolean readOnly)
```
    Indicates whether an attribute group should be visible
    
    Parameters:
    
    group - the attribute group
    
    Returns:
  - usesDefaultGroupOnly
```
boolean usesDefaultGroupOnly()
```
    Returns:
    
    whether only the default attribute gorup is used

Interface EntityModel<T>

Field Summary

Method Summary

Field Detail

ALLOWED_EXTENSIONS

ATTRIBUTE_GROUP

ATTRIBUTE_NAMES

ATTRIBUTE_ORDER

CASCADE

CASCADE_OFF

CASCADE_FILTER_PATH

CASCADE_MODE

CHECKBOX_MODE

COMPLEX_EDITABLE

CURRENCY

DATE_TYPE

DEFAULT_GROUP

DEFAULT_VALUE

DESCRIPTION

DISPLAY_FORMAT

DISPLAY_NAME

DISPLAY_NAME_PLURAL

DISPLAY_PROPERTY

EMBEDDED

FALSE_REPRESENTATION

GROUP_TOGETHER_WITH

IMAGE

MAIN

MAX_LENGTH

MAX_LENGTH_IN_TABLE

MAX_VALUE

MESSAGE_KEY

MIN_LENGTH

MIN_VALUE

MULTIPLE_SEARCH

NAVIGABLE

PERCENTAGE

PRECISION

PROMPT

QUICK_ADD_PROPERTY

READ_ONLY

EDITABLE

REPLACEMENT_SEARCH_PATH

REQUIRED_FOR_SEARCHING

SEARCH_CASE_SENSITIVE

SEARCH_EXACT_VALUE

SEARCH_PREFIX_ONLY

SEARCH_SELECT_MODE

SEARCHABLE

STYLES

SELECT_MODE

NUMBER_SELECT_MODE

SHOW_IN_TABLE

SORT_ORDER

SORTABLE

TEXTFIELD_MODE

THOUSANDS_GROUPING

TRUE_REPRESENTATION

URL

VISIBLE

WEEK

DIRECT_NAVIGATION

Method Detail

addAttributeGroup

addAttributeModel

getAttributeGroups

getAttributeModel

getAttributeModels

getAttributeModelsForGroup

getAttributeModelsForType

getCascadeAttributeModels

getDescription

getDisplayName

getDisplayNamePlural

getDisplayProperty

getEntityClass

getIdAttributeModel

getMainAttributeModel

getReference

getRequiredForSearchingAttributeModels