T - the type of the entitypublic interface EntityModel<T>
| 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
|
| 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() |
static final String ALLOWED_EXTENSIONS
static final String ATTRIBUTE_GROUP
static final String ATTRIBUTE_NAMES
static final String ATTRIBUTE_ORDER
static final String CASCADE
static final String CASCADE_OFF
static final String CASCADE_FILTER_PATH
static final String CASCADE_MODE
static final String CHECKBOX_MODE
static final String COMPLEX_EDITABLE
static final String CURRENCY
static final String DATE_TYPE
static final String DEFAULT_GROUP
static final String DEFAULT_VALUE
static final String DESCRIPTION
static final String DISPLAY_FORMAT
static final String DISPLAY_NAME
static final String DISPLAY_NAME_PLURAL
static final String DISPLAY_PROPERTY
static final String EMBEDDED
static final String FALSE_REPRESENTATION
static final String GROUP_TOGETHER_WITH
static final String IMAGE
static final String MAIN
static final String MAX_LENGTH
static final String MAX_LENGTH_IN_TABLE
static final String MAX_VALUE
static final String MESSAGE_KEY
static final String MIN_LENGTH
static final String MIN_VALUE
static final String MULTIPLE_SEARCH
static final String NAVIGABLE
static final String PERCENTAGE
static final String PRECISION
static final String PROMPT
static final String QUICK_ADD_PROPERTY
static final String READ_ONLY
static final String EDITABLE
static final String REPLACEMENT_SEARCH_PATH
static final String REQUIRED_FOR_SEARCHING
static final String SEARCH_CASE_SENSITIVE
static final String SEARCH_EXACT_VALUE
static final String SEARCH_PREFIX_ONLY
static final String SEARCH_SELECT_MODE
static final String SEARCHABLE
static final String STYLES
static final String SELECT_MODE
static final String NUMBER_SELECT_MODE
static final String SHOW_IN_TABLE
static final String SORT_ORDER
static final String SORTABLE
static final String TEXTFIELD_MODE
static final String THOUSANDS_GROUPING
static final String TRUE_REPRESENTATION
static final String URL
static final String VISIBLE
static final String WEEK
static final String DIRECT_NAVIGATION
void addAttributeGroup(String attributeGroup)
void addAttributeModel(String attributeGroup, AttributeModel model, AttributeModel existingModel)
attributeGroup - The group to which the attribute model should be registeredmodel - The model of the attributeexistingModel - The existing attribute modelList<String> getAttributeGroups()
AttributeModel getAttributeModel(String attributeName)
attributeName - the name of the attributeList<AttributeModel> getAttributeModels()
List<AttributeModel> getAttributeModelsForGroup(String group)
group - the caption of the groupList<AttributeModel> getAttributeModelsForType(AttributeType attributeType, Class<?> type)
attributeType - type - List<AttributeModel> getCascadeAttributeModels()
String getDescription()
String getDisplayName()
String getDisplayNamePlural()
String getDisplayProperty()
Class<T> getEntityClass()
AttributeModel getIdAttributeModel()
AttributeModel getMainAttributeModel()
String getReference()
List<AttributeModel> getRequiredForSearchingAttributeModels()
Map<AttributeModel,Boolean> getSortOrder()
boolean isAttributeGroupVisible(String group, boolean readOnly)
group - the attribute groupboolean usesDefaultGroupOnly()
Copyright © 2019 Open Circle Solutions. All rights reserved.