de.ipcon.schema

Interface EntityI

All Superinterfaces:

BasicEntityI, java.lang.Comparable, DirectedGraphNodeI, OnlyToDirectedGraphNodeI, StructuredEntityI

All Known Implementing Classes:

CBOEntity, EntityWrapper, InstrumentingEntity, VirtualEntity

public interface EntityI
extends StructuredEntityI, java.lang.Comparable, DirectedGraphNodeI

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EntityI.EntityMatcher
static class	EntityI.NonPersistentEdgeFilter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATT_NAME_ABSTRACT
static java.lang.String	ATT_NAME_CODE_CUSTOM
static java.lang.String	ATT_NAME_CODE_DEPENDENTS
static java.lang.String	ATT_NAME_CODE_GENERATE
static java.lang.String	ATT_NAME_CODE_GENERATE_AS
static java.lang.String	ATT_NAME_CODE_PACKAGE
static java.lang.String	ATT_NAME_DB_FORBID_DIRECT_CHANGES
static java.lang.String	ATT_NAME_DB_LOW_INSTANCE_COUNT
static java.lang.String	ATT_NAME_DB_NAME
static java.lang.String	ATT_NAME_DB_NO_STREAM_RESOURCE_HISTORY
static java.lang.String	ATT_NAME_DB_PERSISTENT
static java.lang.String	ATT_NAME_DB_STREAM_RESOURCE
static java.lang.String	ATT_NAME_DISCRIMINATOR
static java.lang.String	ATT_NAME_EXPORT_MODE
static java.lang.String	ATT_NAME_EXPORT_NAME
static java.lang.String	ATT_NAME_EXPORT_PRIMARY_KEY
static java.lang.String	ATT_NAME_EXTENDS
static java.lang.String	ATT_NAME_FOLDER
static java.lang.String	ATT_NAME_FULLTEXT_BOOST
static java.lang.String	ATT_NAME_FULLTEXT_INDEXED
static java.lang.String	ATT_NAME_GDPR_DATA_CATEGORY Represents the `<dataCategory>` attribute of the gdpr subnode, which defines the associated GDPR data category.
static java.lang.String	ATT_NAME_GDPR_RETENTION_START_DATE_PATH Represents the `<retentionStartDatePath>` attribute of the gdpr subnode, which defines a path to the retention start date.
static java.lang.String	ATT_NAME_IGNORE_REVERSE_RELATIONS
static java.lang.String	ATT_NAME_IMPLEMENTS_NAME
static java.lang.String	ATT_NAME_LOOKUP_DEFAULT_CASE_SENSITIVE
static java.lang.String	ATT_NAME_LOOKUP_DEFAULT_PROPERTY
static java.lang.String	ATT_NAME_LOOKUP_DEFAULT_SUBSTRING
static java.lang.String	ATT_NAME_MERGE
static java.lang.String	ATT_NAME_NAME
static java.lang.String	ATT_NAME_NO_ABSTRACT_WARNING
static java.lang.String	ATT_NAME_PACKAGE
static java.lang.String	ATT_NAME_PLURAL
static java.lang.String	ATT_NAME_REPORT_FONT_SIZE_BIG
static java.lang.String	ATT_NAME_REPORT_FONT_SIZE_NORMAL
static java.lang.String	ATT_NAME_REPORT_ORIENTATION
static java.lang.String	ATT_NAME_REPORT_TITLE
static java.lang.String	ATT_NAME_SUID
static java.lang.String	ATT_NAME_UI_DEFAULT_SELECTION_FILTER
static java.lang.String	ATT_NAME_UI_DEFAULT_SORTING
static java.lang.String	ATT_NAME_UI_DESCRIPTION
static java.lang.String	ATT_NAME_UI_LINK_ONLY
static java.lang.String	ATT_NAME_UI_LOAD_IMMEDIATE
static java.lang.String	ATT_NAME_UI_TIPS
static java.lang.String	DEFAULT_GENERATE_AS_SUFFIX
static java.lang.String	DEFAULT_SORTING_ASC
static java.lang.String	DEFAULT_SORTING_DESC
static java.lang.String	DEPENDENTS_SEPARATOR_CHAR
static java.lang.String	EL_NAME_ACTION
static java.lang.String	EL_NAME_ATTR
static java.lang.String	EL_NAME_CODE
static java.lang.String	EL_NAME_COMMENT
static java.lang.String	EL_NAME_DB
static java.lang.String	EL_NAME_EXPORT
static java.lang.String	EL_NAME_FULLTEXT
static java.lang.String	EL_NAME_GDPR
static java.lang.String	EL_NAME_IMPLEMENTS
static java.lang.String	EL_NAME_LOOKUP
static java.lang.String	EL_NAME_NPATTR
static java.lang.String	EL_NAME_REPORT
static java.lang.String	EL_NAME_UI
static java.lang.String	EL_NAME_VATTR
static EntityI[]	EMPTY_ARRAY
static java.lang.String	EXPORT_MODE_IF_REFERENCED
static java.lang.String	EXPORT_MODE_LIST
static java.lang.String	EXPORT_MODE_NEVER
static java.lang.String	EXPORT_MODE_SINGLE
static java.lang.String	GENERATE_AS_DELIMITER_CHAR
static java.util.Set<java.lang.String>	RESERVED_TABLE_NAMES

Fields inherited from interface de.ipcon.schema.StructuredEntityI

$0, $01

Fields inherited from interface de.ipcon.tools.graph.DirectedGraphNodeI

$0

Method Summary

Modifier and Type	Method and Description
void	addRelationObject(java.lang.Object bo, java.lang.String attName, java.lang.Object value) Adds the given value to the relation specified via its attribute name in the given bo
default java.util.Collection<GraphPath>	findReachableAttrsWithType(EntityI wantedEntity) Find by which relation chains a given entity is referenced from this EntityI.
default java.util.Collection<GraphPath>	findReachableAttrsWithType(EntityI wantedEntity, boolean ignoreNonPersistents) Find by which relation chains a given entity is referenced from this EntityI.
java.util.List<CBOAction>	getActionList()
java.util.List<java.lang.Class>	getClassesUpToPreviousEntity()
java.lang.Boolean	getDefaultLookupCaseSensitive()
java.lang.String	getDefaultLookupProperty()
java.lang.Boolean	getDefaultLookupStartingWith()
java.lang.Boolean	getDefaultLookupSubstring()
java.lang.String	getDefaultSelectionFilter() Returns a filter-clause that acts as a non-interactive filter within a query.
java.lang.String	getDefaultSortDirection(java.lang.String path) Returns the default sorting direction of the DefaultSortDefinitionEntry found under the given path in the defaultSorting for the current EntityI, null otherwise.
java.util.Map<java.lang.String,DefaultSortDefinitionEntry>	getDefaultSorting() Returns the defaultSorting for the current EntityI, recursivly checking the base EntityI-s, too, until a defaultSorting is found.
java.lang.Integer	getDefaultSortLevel(java.lang.String path) Returns the default sorting level of the DefaultSortDefinitionEntry found under the given path in the defaultSorting for the current EntityI, null otherwise.
java.util.List<java.lang.String>	getDependentClasses()
java.lang.Long	getDiscriminator()
ExportDefinitionEntry	getExport(java.lang.String name) Returns the ExportDefinitionEntry of this EntityI or any of its super-entities with the passed name if it exists, null otherwise.
ExportDefinitionEntry	getExport(java.lang.String name, boolean includeSuper) Returns the ExportDefinitionEntry of this EntityI with the passed name if it exists, null otherwise.
java.util.List<ExportDefinitionEntry>	getExports() Returns a list of all ExportDefinitionEntry-s for this EntityI or any of its super-entities.
java.util.List<ExportDefinitionEntry>	getExports(boolean includeSuper) Returns a list of all ExportDefinitionEntry-s for this EntityI.
java.lang.String	getFQName()
default java.util.Collection<OnlyToDirectedGraphNodeI>	getFromNodes() Gets all nodes from which the incoming edges to this node originate.
java.lang.Float	getFTSBoost()
GDPRPolicy	getGDPRPolicy()
java.lang.String	getGuiTip(java.lang.String tip) Returns the gui tip for the given key from the current EntityI or one of its super EntityI-s.
java.lang.String	getGuiTip(java.lang.String tip, boolean inherited) Returns the gui tip for the given key from the current EntityI.
int	getGuiTipAsInt(java.lang.String tip) Returns the gui tip for the given key from the current entity or one of its super EntityI-s as int.
int	getGuiTipAsInt(java.lang.String tip, boolean inherited) Returns the gui tip for the given key from the current entity as int.
default java.util.Collection<GraphEdgeI>	getIncomingEdges()
java.lang.Boolean	getIndexedForFTS()
java.lang.String	getL10nName() Returns the translated name for the current EntityI using L10nBundles
java.lang.String	getL10nName(boolean returnKeyWhenNotFound) Returns the translated name for the current EntityI using L10nBundles
java.lang.String	getL10nNameKey() Returns an L10n message key for the name of the current EntityI without spaces and not permitted characters.
java.lang.String	getL10nNameVar() Returns the L10n variable for the name of the current EntityI
java.lang.String	getL10nPlural() Returns the translated name for the current EntityI as plural using L10nBundles
java.lang.String	getL10nPlural(boolean returnKeyWhenNotFound) Returns the translated singular name for the current EntityI as plural using L10nBundles
java.lang.String	getL10nPluralKey() Returns an L10n message key for the name of the current EntityI as plural without spaces and not permitted characters
java.lang.String	getL10nPluralVar() Returns the L10n variable for the name of the current EntityI as plural
java.lang.Boolean	getLinkOnly() Checks if the linkOnly-flag is set for this EntityI or one of its base EntityI-s.
default java.util.Collection<GraphEdgeI>	getOutgoingEdges()
java.lang.String	getPackage() Returns the package of the current EntityI
java.lang.String	getPackageAsPath() Returns the package of the current EntityI, but as a relative file system path
java.lang.Class	getPersistenceAspectClass() Returns the generateAs-class for the current EntityI
java.util.Map	getRelationObjects(java.lang.Object bo, java.lang.String attName) Returns a map containing the relation for a single attribute of a bo of this EntityI
java.lang.Integer	getReportFontSizeBig()
java.lang.Integer	getReportFontSizeNormal()
java.lang.String	getReportOrientation()
java.lang.String	getReportTitle()
default java.util.Collection<OnlyToDirectedGraphNodeI>	getToNodes() Gets all nodes to which the outgoing edges from this node lead.
default java.lang.String	getToolTipTextForAttribute(AttributeI attr)
java.lang.Object	getValue(java.lang.Object bo, java.lang.String attPath) Returns the value contained in the given BO and reached via the given attPath.
java.lang.String	getValueAsString(java.lang.Object bo, java.lang.String attPath) Returns the value contained in the given BO and reached via the given attPath as String.
boolean	hasGuiTip(java.lang.String tip) Checks if the current EntityI or one of its super EntityI-s has a gui tip with the given key.
boolean	hasGuiTip(java.lang.String tip, boolean inherited) Checks if the current EntityI has a gui tip with the given key.
boolean	hasRelationObject(java.lang.Object bo, java.lang.String attName, java.lang.Object value) Returns true if the given object is part of the relation specified via its attribute name in the given bo
boolean	isForbidDirectChanges()
boolean	isLinkOnly() Checks if the linkOnly-flag is set for this EntityI or one of its base EntityI-s.
boolean	isLoadImmediate()
boolean	isNoStreamResourceHistory()
boolean	isStreamResource()
default java.lang.String	parametersToString()
void	removeRelationObject(java.lang.Object bo, java.lang.String attName, java.lang.Object value) Removes the given object from the relation specified via its attribute name in the given bo
void	setDiscriminator(java.lang.Long id) Sets the Discriminator (i.e. the BOT Id) for this EntityI
void	setValue(java.lang.Object bo, java.lang.String attPath, java.lang.Object value) Sets the given value in the given bo using the given attPath.
void	setValueAsString(java.lang.Object bo, java.lang.String attPath, java.lang.String value) Sets the given value as String to the given bo using the given attPath.
void	setValueAsString(java.lang.Object bo, java.lang.String attPath, java.lang.String value, boolean checkConstraints) Sets the given value as String in the given bo using the given attPath.
static java.util.List<EntityI>	toEntities(SchemaI schema, java.util.List<java.lang.String> entityNames) Converts a list of Strings representing entity names to a list of EntityIs, filtering out the ones, for which no EntityI was not found in the passed schema.
java.lang.String	toString()

Methods inherited from interface de.ipcon.schema.StructuredEntityI

getAllAttributeList, getAllAttributeList, getAllAttributeList, getAllAttributeListByType, getAllAttributeListByType, getAllAttributeListByType, getAllAttributeListByType, getAllAttributeListWithoutSubentities, getAllAttributeListWithoutSubentities, getAllSubEntityList, getAllSubEntityList, getAllSubEntityList, getAttChain, getAttChain, getAttribute, getBaseEntity, getPersistentBaseEntity, getSubEntityList, hasPersistentSubentity, hasSubEntities, isEffectivelyPersistent, isImplicitlyPersistent, isSubEntityOf, isSubEntityOf

Methods inherited from interface de.ipcon.schema.BasicEntityI

getAttributeList, getAttributeListByType, getAttributeListByType, getClazz, getDescription, getFolderName, getImplementedSchemaInterfaces, getName, getPlural, getRelations, getSchema, getSingleAttribute, isCustom, isPersistent, isUserAbstract, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

RESERVED_TABLE_NAMES

static final java.util.Set<java.lang.String> RESERVED_TABLE_NAMES

EL_NAME_ATTR

static final java.lang.String EL_NAME_ATTR

See Also:

Constant Field Values

EL_NAME_VATTR

static final java.lang.String EL_NAME_VATTR

See Also:

Constant Field Values

EL_NAME_NPATTR

static final java.lang.String EL_NAME_NPATTR

See Also:

Constant Field Values

EL_NAME_IMPLEMENTS

static final java.lang.String EL_NAME_IMPLEMENTS

See Also:

Constant Field Values

EL_NAME_UI

static final java.lang.String EL_NAME_UI

See Also:

Constant Field Values

EL_NAME_LOOKUP

static final java.lang.String EL_NAME_LOOKUP

See Also:

Constant Field Values

EL_NAME_CODE

static final java.lang.String EL_NAME_CODE

See Also:

Constant Field Values

EL_NAME_DB

static final java.lang.String EL_NAME_DB

See Also:

Constant Field Values

EL_NAME_REPORT

static final java.lang.String EL_NAME_REPORT

See Also:

Constant Field Values

EL_NAME_FULLTEXT

static final java.lang.String EL_NAME_FULLTEXT

See Also:

Constant Field Values

EL_NAME_EXPORT

static final java.lang.String EL_NAME_EXPORT

See Also:

Constant Field Values

EL_NAME_ACTION

static final java.lang.String EL_NAME_ACTION

See Also:

Constant Field Values

EL_NAME_COMMENT

static final java.lang.String EL_NAME_COMMENT

See Also:

Constant Field Values

EL_NAME_GDPR

static final java.lang.String EL_NAME_GDPR

See Also:

Constant Field Values

ATT_NAME_NAME

static final java.lang.String ATT_NAME_NAME

See Also:

Constant Field Values

ATT_NAME_MERGE

static final java.lang.String ATT_NAME_MERGE

See Also:

Constant Field Values

ATT_NAME_EXTENDS

static final java.lang.String ATT_NAME_EXTENDS

See Also:

Constant Field Values

ATT_NAME_PLURAL

static final java.lang.String ATT_NAME_PLURAL

See Also:

Constant Field Values

ATT_NAME_ABSTRACT

static final java.lang.String ATT_NAME_ABSTRACT

See Also:

Constant Field Values

ATT_NAME_IGNORE_REVERSE_RELATIONS

static final java.lang.String ATT_NAME_IGNORE_REVERSE_RELATIONS

See Also:

Constant Field Values

ATT_NAME_DISCRIMINATOR

static final java.lang.String ATT_NAME_DISCRIMINATOR

See Also:

Constant Field Values

ATT_NAME_SUID

static final java.lang.String ATT_NAME_SUID

See Also:

Constant Field Values

ATT_NAME_FOLDER

static final java.lang.String ATT_NAME_FOLDER

See Also:

Constant Field Values

ATT_NAME_PACKAGE

static final java.lang.String ATT_NAME_PACKAGE

See Also:

Constant Field Values

ATT_NAME_NO_ABSTRACT_WARNING

static final java.lang.String ATT_NAME_NO_ABSTRACT_WARNING

See Also:

Constant Field Values

ATT_NAME_IMPLEMENTS_NAME

static final java.lang.String ATT_NAME_IMPLEMENTS_NAME

See Also:

Constant Field Values

ATT_NAME_UI_DESCRIPTION

static final java.lang.String ATT_NAME_UI_DESCRIPTION

See Also:

Constant Field Values

ATT_NAME_UI_LOAD_IMMEDIATE

static final java.lang.String ATT_NAME_UI_LOAD_IMMEDIATE

See Also:

Constant Field Values

ATT_NAME_UI_LINK_ONLY

static final java.lang.String ATT_NAME_UI_LINK_ONLY

See Also:

Constant Field Values

ATT_NAME_UI_TIPS

static final java.lang.String ATT_NAME_UI_TIPS

See Also:

Constant Field Values

ATT_NAME_UI_DEFAULT_SORTING

static final java.lang.String ATT_NAME_UI_DEFAULT_SORTING

See Also:

Constant Field Values

ATT_NAME_UI_DEFAULT_SELECTION_FILTER

static final java.lang.String ATT_NAME_UI_DEFAULT_SELECTION_FILTER

See Also:

Constant Field Values

ATT_NAME_LOOKUP_DEFAULT_PROPERTY

static final java.lang.String ATT_NAME_LOOKUP_DEFAULT_PROPERTY

See Also:

Constant Field Values

ATT_NAME_LOOKUP_DEFAULT_SUBSTRING

static final java.lang.String ATT_NAME_LOOKUP_DEFAULT_SUBSTRING

See Also:

Constant Field Values

ATT_NAME_LOOKUP_DEFAULT_CASE_SENSITIVE

static final java.lang.String ATT_NAME_LOOKUP_DEFAULT_CASE_SENSITIVE

See Also:

Constant Field Values

ATT_NAME_CODE_PACKAGE

static final java.lang.String ATT_NAME_CODE_PACKAGE

See Also:

Constant Field Values

ATT_NAME_CODE_GENERATE_AS

static final java.lang.String ATT_NAME_CODE_GENERATE_AS

See Also:

Constant Field Values

ATT_NAME_CODE_CUSTOM

static final java.lang.String ATT_NAME_CODE_CUSTOM

See Also:

Constant Field Values

ATT_NAME_CODE_GENERATE

static final java.lang.String ATT_NAME_CODE_GENERATE

See Also:

Constant Field Values

ATT_NAME_CODE_DEPENDENTS

static final java.lang.String ATT_NAME_CODE_DEPENDENTS

See Also:

Constant Field Values

ATT_NAME_DB_NAME

static final java.lang.String ATT_NAME_DB_NAME

See Also:

Constant Field Values

ATT_NAME_DB_PERSISTENT

static final java.lang.String ATT_NAME_DB_PERSISTENT

See Also:

Constant Field Values

ATT_NAME_DB_STREAM_RESOURCE

static final java.lang.String ATT_NAME_DB_STREAM_RESOURCE

See Also:

Constant Field Values

ATT_NAME_DB_NO_STREAM_RESOURCE_HISTORY

static final java.lang.String ATT_NAME_DB_NO_STREAM_RESOURCE_HISTORY

See Also:

Constant Field Values

ATT_NAME_DB_FORBID_DIRECT_CHANGES

static final java.lang.String ATT_NAME_DB_FORBID_DIRECT_CHANGES

See Also:

Constant Field Values

ATT_NAME_DB_LOW_INSTANCE_COUNT

static final java.lang.String ATT_NAME_DB_LOW_INSTANCE_COUNT

See Also:

Constant Field Values

ATT_NAME_REPORT_TITLE

static final java.lang.String ATT_NAME_REPORT_TITLE

See Also:

Constant Field Values

ATT_NAME_REPORT_ORIENTATION

static final java.lang.String ATT_NAME_REPORT_ORIENTATION

See Also:

Constant Field Values

ATT_NAME_REPORT_FONT_SIZE_NORMAL

static final java.lang.String ATT_NAME_REPORT_FONT_SIZE_NORMAL

See Also:

Constant Field Values

ATT_NAME_REPORT_FONT_SIZE_BIG

static final java.lang.String ATT_NAME_REPORT_FONT_SIZE_BIG

See Also:

Constant Field Values

ATT_NAME_FULLTEXT_INDEXED

static final java.lang.String ATT_NAME_FULLTEXT_INDEXED

See Also:

Constant Field Values

ATT_NAME_FULLTEXT_BOOST

static final java.lang.String ATT_NAME_FULLTEXT_BOOST

See Also:

Constant Field Values

ATT_NAME_EXPORT_NAME

static final java.lang.String ATT_NAME_EXPORT_NAME

See Also:

Constant Field Values

ATT_NAME_EXPORT_PRIMARY_KEY

static final java.lang.String ATT_NAME_EXPORT_PRIMARY_KEY

See Also:

Constant Field Values

ATT_NAME_EXPORT_MODE

static final java.lang.String ATT_NAME_EXPORT_MODE

See Also:

Constant Field Values

ATT_NAME_GDPR_DATA_CATEGORY

static final java.lang.String ATT_NAME_GDPR_DATA_CATEGORY

Represents the `<dataCategory>` attribute of the gdpr subnode, which defines the associated GDPR data category.

See Also:

Constant Field Values

ATT_NAME_GDPR_RETENTION_START_DATE_PATH

static final java.lang.String ATT_NAME_GDPR_RETENTION_START_DATE_PATH

Represents the `<retentionStartDatePath>` attribute of the gdpr subnode, which defines a path to the retention start date.

See Also:

Constant Field Values

DEFAULT_GENERATE_AS_SUFFIX

static final java.lang.String DEFAULT_GENERATE_AS_SUFFIX

See Also:

Constant Field Values

GENERATE_AS_DELIMITER_CHAR

static final java.lang.String GENERATE_AS_DELIMITER_CHAR

See Also:

Constant Field Values

DEPENDENTS_SEPARATOR_CHAR

static final java.lang.String DEPENDENTS_SEPARATOR_CHAR

See Also:

Constant Field Values

DEFAULT_SORTING_ASC

static final java.lang.String DEFAULT_SORTING_ASC

See Also:

Constant Field Values

DEFAULT_SORTING_DESC

static final java.lang.String DEFAULT_SORTING_DESC

See Also:

Constant Field Values

EXPORT_MODE_NEVER

static final java.lang.String EXPORT_MODE_NEVER

See Also:

Constant Field Values

EXPORT_MODE_IF_REFERENCED

static final java.lang.String EXPORT_MODE_IF_REFERENCED

See Also:

Constant Field Values

EXPORT_MODE_SINGLE

static final java.lang.String EXPORT_MODE_SINGLE

See Also:

Constant Field Values

EXPORT_MODE_LIST

static final java.lang.String EXPORT_MODE_LIST

See Also:

Constant Field Values

EMPTY_ARRAY

static final EntityI[] EMPTY_ARRAY

Method Detail

toEntities

static java.util.List<EntityI> toEntities(SchemaI schema,
                                          java.util.List<java.lang.String> entityNames)

Converts a list of Strings representing entity names to a list of EntityIs, filtering out the ones, for which no EntityI was not found in the passed schema.

getPackage

java.lang.String getPackage()

Returns the package of the current EntityI

Returns:

the package of the current EntityI

getPackageAsPath

java.lang.String getPackageAsPath()

Returns the package of the current EntityI, but as a relative file system path

Returns:

a relative file system path based off the package

getFQName

java.lang.String getFQName()

Returns:

the fully qualified name of this EntityI

isStreamResource

boolean isStreamResource()

Returns:

true if the current EntityI or one of its base EntityIs is a stream ressource

isNoStreamResourceHistory

boolean isNoStreamResourceHistory()

Returns:

true if the current EntityI or one of its base EntityIs was told to keep no history of its stream ressource when a stream resource is replaced by a different one

isForbidDirectChanges

boolean isForbidDirectChanges()

Returns:

true if direct changes to objects with this EntityI are forbidden

getClassesUpToPreviousEntity

java.util.List<java.lang.Class> getClassesUpToPreviousEntity()

Returns:

a list of all classes that exist between this Entity and its base EntityI

getPersistenceAspectClass

java.lang.Class getPersistenceAspectClass()

Returns the generateAs-class for the current EntityI

Returns:

the generateAs-class for the current EntityI

Throws:

java.lang.IllegalStateException - if no class with the generateAs as name could be found

getL10nNameKey

java.lang.String getL10nNameKey()

Returns an L10n message key for the name of the current EntityI without spaces and not permitted characters.

Returns:

L10n message key for the name of the current EntityI

getL10nNameVar

java.lang.String getL10nNameVar()

Returns the L10n variable for the name of the current EntityI

Returns:

L10n variable for the name of the current EntityI

getL10nName

java.lang.String getL10nName()

Returns the translated name for the current EntityI using L10nBundles

Returns:

the translated name for the current EntityI

getL10nName

java.lang.String getL10nName(boolean returnKeyWhenNotFound)

Returns the translated name for the current EntityI using L10nBundles

Parameters:

returnKeyWhenNotFound - if true the key will be returned if key couldnt be translated

Returns:

the translated name for the current EntityI

getL10nPluralKey

java.lang.String getL10nPluralKey()

Returns an L10n message key for the name of the current EntityI as plural without spaces and not permitted characters

Returns:

plural L10n message key for the current entity as plural

getL10nPluralVar

java.lang.String getL10nPluralVar()

Returns the L10n variable for the name of the current EntityI as plural

Returns:

L10n variable for the name of the current EntityI as plural

getL10nPlural

java.lang.String getL10nPlural()

Returns the translated name for the current EntityI as plural using L10nBundles

Returns:

the translated name for the current EntityI as plural

getL10nPlural

java.lang.String getL10nPlural(boolean returnKeyWhenNotFound)

Returns the translated singular name for the current EntityI as plural using L10nBundles

Parameters:

returnKeyWhenNotFound - if true the key will be returned if key couldnt be translated

Returns:

the translated name for the current EntityI as plural

getActionList

java.util.List<CBOAction> getActionList()

Returns:

a List containing all possible CBOAction-s of this EntityI

getValue

java.lang.Object getValue(java.lang.Object bo,
                          java.lang.String attPath)

Returns the value contained in the given BO and reached via the given attPath. If the attribute is transient the value will be fetched from the transient properties of the BO.

Parameters:

bo - the bo to get the value from

attPath - the path to the attribute to get the value from

Returns:

the attribue value

getValueAsString

java.lang.String getValueAsString(java.lang.Object bo,
                                  java.lang.String attPath)

Returns the value contained in the given BO and reached via the given attPath as String. If the attribute is transient the value will be fetched from the transient properties of the BO.

Parameters:

bo - the bo to get the value from

attPath - the path to the attribute to get the value from

Returns:

the attribue value as String

setValue

void setValue(java.lang.Object bo,
              java.lang.String attPath,
              java.lang.Object value)

Sets the given value in the given bo using the given attPath.

Parameters:

bo - the bo to set the given value in

attPath - the path to the attribute to set

value - the value to set

setValueAsString

void setValueAsString(java.lang.Object bo,
                      java.lang.String attPath,
                      java.lang.String value,
                      boolean checkConstraints)

Sets the given value as String in the given bo using the given attPath.

Parameters:

bo - the bo to set the given value in

attPath - the path to the attribute to set

value - the value to set as String

checkConstraints - do check for constraints before setting value

setValueAsString

void setValueAsString(java.lang.Object bo,
                      java.lang.String attPath,
                      java.lang.String value)

Sets the given value as String to the given bo using the given attPath. Does check for constraints before setting the value.

Parameters:

bo - the bo to set the given value in

attPath - the path to the attribute to set

value - the value to set as String

getRelationObjects

java.util.Map getRelationObjects(java.lang.Object bo,
                                 java.lang.String attName)

Returns a map containing the relation for a single attribute of a bo of this EntityI

Parameters:

bo - the bo to get relations for

attName - the attribute to get relations for

Returns:

the relations map for the attribute

addRelationObject

void addRelationObject(java.lang.Object bo,
                       java.lang.String attName,
                       java.lang.Object value)

Adds the given value to the relation specified via its attribute name in the given bo

Parameters:

bo - the bo to add the relational object to the attribute

attName - the name of the attribute to add the relational object to

value - the relational object to add to the attribute on the bo

removeRelationObject

void removeRelationObject(java.lang.Object bo,
                          java.lang.String attName,
                          java.lang.Object value)

Removes the given object from the relation specified via its attribute name in the given bo

Parameters:

bo - the bo to remove the relational object from the attribute

attName - the name of the attribute to remove the relational object from

value - the relational object to remove

hasRelationObject

boolean hasRelationObject(java.lang.Object bo,
                          java.lang.String attName,
                          java.lang.Object value)

Returns true if the given object is part of the relation specified via its attribute name in the given bo

Parameters:

bo - the bo to check the relational object on the attribute

attName - the name of the attribute to check the relational object on

value - the relational object to check

hasGuiTip

boolean hasGuiTip(java.lang.String tip,
                  boolean inherited)

Checks if the current EntityI has a gui tip with the given key. If parameter inherited is passed as true the super EntityI-s are checked recursively, too.

Parameters:

tip - the key to check

inherited - a boolean indicating whether to check for inherited tips too

Returns:

true if a tip with the given key exists

hasGuiTip

boolean hasGuiTip(java.lang.String tip)

Checks if the current EntityI or one of its super EntityI-s has a gui tip with the given key.

Parameters:

tip - the key to check

Returns:

true if a tip with the given key exists

getGuiTip

java.lang.String getGuiTip(java.lang.String tip,
                           boolean inherited)

Returns the gui tip for the given key from the current EntityI. If parameter inherited is passed as true the super EntityI-s are checked recursively, too.

Parameters:

tip - the key for the tip to return

inherited - a boolean indicating whether to check for inherited tips too

Returns:

the gui tip for the given key

getGuiTip

java.lang.String getGuiTip(java.lang.String tip)

Returns the gui tip for the given key from the current EntityI or one of its super EntityI-s.

Parameters:

tip - the key for the tip to return

Returns:

the gui tip for the given key

getGuiTipAsInt

int getGuiTipAsInt(java.lang.String tip,
                   boolean inherited)

Returns the gui tip for the given key from the current entity as int. If parameter inherited is passed as true the super EntityI-s are checked recursively, too.

Parameters:

tip - the key for the tip to return

inherited - a boolean indicating whether to check for inherited tips too

Returns:

the gui tip as int for the given key

Throws:

IRuntimeException - if the gui tip with the given key was no Integer-value

getGuiTipAsInt

int getGuiTipAsInt(java.lang.String tip)

Returns the gui tip for the given key from the current entity or one of its super EntityI-s as int.

Parameters:

tip - the key for the tip to return

Returns:

the gui tip as int for the given key

Throws:

IRuntimeException - if the gui tip with the given key was no Integer-value

isLinkOnly

boolean isLinkOnly()

Checks if the linkOnly-flag is set for this EntityI or one of its base EntityI-s. If the linkOnly-flag is set for a base EntityI, as a side-effect it will be set for this EntityI too!

Returns:

true if the linkOnly-flag is set

getLinkOnly

java.lang.Boolean getLinkOnly()

Checks if the linkOnly-flag is set for this EntityI or one of its base EntityI-s. If the linkOnly-flag is set for a base EntityI, as a side-effect it will be set for this EntityI too!

Returns:

Boolean.TRUE if the linkOnly-flag is set

isLoadImmediate

boolean isLoadImmediate()

Returns:

the boolean value of loadImmediate for this EntityI, or false if loadImmediate wasn"t set and couldn"t be retrieved from a base entity

getDefaultLookupProperty

java.lang.String getDefaultLookupProperty()

Returns:

the defaultLookupProperty of the current EntityI or the first one of its base Entity-s.

getDefaultLookupSubstring

java.lang.Boolean getDefaultLookupSubstring()

Returns:

Boolean.TRUE if this EntityI or one of its base EntityI-s has a default lookup String

getDefaultLookupStartingWith

java.lang.Boolean getDefaultLookupStartingWith()

Returns:

Boolean.TRUE if this EntityI or one of its base EntityI-s only allows lookup for prefixes by default

getDefaultLookupCaseSensitive

java.lang.Boolean getDefaultLookupCaseSensitive()

Returns:

Boolean.TRUE if this EntityI or one of its base EntityI-s performs lookups case-insensitive by default

getDefaultSorting

java.util.Map<java.lang.String,DefaultSortDefinitionEntry> getDefaultSorting()

Returns the defaultSorting for the current EntityI, recursivly checking the base EntityI-s, too, until a defaultSorting is found.

Returns:

the defaultSorting for the current EntityI as Map

getDefaultSortDirection

java.lang.String getDefaultSortDirection(java.lang.String path)

Returns the default sorting direction of the DefaultSortDefinitionEntry found under the given path in the defaultSorting for the current EntityI, null otherwise.

Parameters:

path - the path of the DefaultSortDefinitionEntry in defaultSorting

Returns:

the default sorting direction of the DefaultSortDefinitionEntry with the given path as String

getDefaultSortLevel

java.lang.Integer getDefaultSortLevel(java.lang.String path)

Returns the default sorting level of the DefaultSortDefinitionEntry found under the given path in the defaultSorting for the current EntityI, null otherwise.

Parameters:

path - the path of the DefaultSortDefinitionEntry in defaultSorting

Returns:

the default sorting level of the DefaultSortDefinitionEntry with the given path as Integer

getDefaultSelectionFilter

java.lang.String getDefaultSelectionFilter()

Returns a filter-clause that acts as a non-interactive filter within a query. If an AttributeI of the type of this EntityI or a subentity thereof is used as a property and has no own selection filter defined, this filter is used to restrict the selection.

Returns:

the default filter-clause for the current EntityI or the first one of its base Entity-s.

getToolTipTextForAttribute

default java.lang.String getToolTipTextForAttribute(AttributeI attr)

getReportTitle

java.lang.String getReportTitle()

Returns:

the report title, or null if report title wasn"t set and couldn"t be retrieved from a base entity

getReportOrientation

java.lang.String getReportOrientation()

Returns:

the report orientation, or null if report orientation wasn"t set and couldn"t be retrieved from a base entity

getReportFontSizeNormal

java.lang.Integer getReportFontSizeNormal()

Returns:

the report"s normal font size, or null if the report"s normal font size wasn"t set and couldn"t be retrieved from a base entity

getReportFontSizeBig

java.lang.Integer getReportFontSizeBig()

Returns:

the report"s big font size, or null if the report"s big font size wasn"t set and couldn"t be retrieved from a base entity

getExports

java.util.List<ExportDefinitionEntry> getExports()

Returns a list of all ExportDefinitionEntry-s for this EntityI or any of its super-entities.

Returns:

a list of all ExportDefinitionEntry-s for this EntityI or any of its super-entities.

getExports

java.util.List<ExportDefinitionEntry> getExports(boolean includeSuper)

Returns a list of all ExportDefinitionEntry-s for this EntityI.

Parameters:

includeSuper - a boolean which denotes if also exports from all super-entities shall be included.

Returns:

a list of all ExportDefinitionEntry-s for this EntityI.

getExport

ExportDefinitionEntry getExport(java.lang.String name)

Returns the ExportDefinitionEntry of this EntityI or any of its super-entities with the passed name if it exists, null otherwise.

Parameters:

name - the name of the ExportDefinitionEntry to return

Returns:

the ExportDefinitionEntry of this EntityI or any of its super-entities with the passed name if it exists, null otherwise.

getExport

ExportDefinitionEntry getExport(java.lang.String name,
                                boolean includeSuper)

Returns the ExportDefinitionEntry of this EntityI with the passed name if it exists, null otherwise.

Parameters:

name - the name of the ExportDefinitionEntry to return

includeSuper - a boolean which denotes if also exports from all super-entities shall be searched.

Returns:

the ExportDefinitionEntry of this EntityI with the passed name if it exists, null otherwise.

getDependentClasses

java.util.List<java.lang.String> getDependentClasses()

Returns:

a List containing all simple class names (file names excluding the filetype) of classes being dependent on this EntityI

setDiscriminator

void setDiscriminator(java.lang.Long id)

Sets the Discriminator (i.e. the BOT Id) for this EntityI

Parameters:

id - the id to set as discriminator

Throws:

java.lang.IllegalArgumentException - if the given id was null or the discriminator of this EntityI was already set

getDiscriminator

java.lang.Long getDiscriminator()

Returns:

the discriminator (i.e. the BOT Id) for this EntityI

getIndexedForFTS

java.lang.Boolean getIndexedForFTS()

Returns:

Boolean.TRUE if this EntityI or any of its super-EntityI-s is indexed for fulltext search.

getFTSBoost

java.lang.Float getFTSBoost()

Returns:

a Float indicating the fulltext search boost parameter for this EntityI

getGDPRPolicy

GDPRPolicy getGDPRPolicy()

parametersToString

default java.lang.String parametersToString()

toString

java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

a String containing all information about the current EntityI

getToNodes

default java.util.Collection<OnlyToDirectedGraphNodeI> getToNodes()

Description copied from interface: OnlyToDirectedGraphNodeI

Gets all nodes to which the outgoing edges from this node lead. In a tree graph these could be called the children.

Specified by:

getToNodes in interface OnlyToDirectedGraphNodeI

Returns:

Collection of all nodes to which the outgoing edges from this node lead

getFromNodes

default java.util.Collection<OnlyToDirectedGraphNodeI> getFromNodes()

Description copied from interface: DirectedGraphNodeI

Gets all nodes from which the incoming edges to this node originate. In a tree graph these could be called the ancestors.

Specified by:

getFromNodes in interface DirectedGraphNodeI

Returns:

Collection of all nodes from which the incoming edges to this node originate

getOutgoingEdges

default java.util.Collection<GraphEdgeI> getOutgoingEdges()

Specified by:

getOutgoingEdges in interface OnlyToDirectedGraphNodeI

getIncomingEdges

default java.util.Collection<GraphEdgeI> getIncomingEdges()

Specified by:

getIncomingEdges in interface DirectedGraphNodeI

findReachableAttrsWithType

default java.util.Collection<GraphPath> findReachableAttrsWithType(EntityI wantedEntity)

Find by which relation chains a given entity is referenced from this EntityI. Relation chains that include non-persistent attributes are ignored.

Parameters:

wantedEntity - The EntityI in question.

Returns:

All GraphPath instances representing relation chains to the wanted entity. These paths consist of this instance as the start node and relation AttributeI instances as edges/path elements leading to the wanted entity.

findReachableAttrsWithType

default java.util.Collection<GraphPath> findReachableAttrsWithType(EntityI wantedEntity,
                                                                   boolean ignoreNonPersistents)

Find by which relation chains a given entity is referenced from this EntityI.

Parameters:

wantedEntity - The EntityI in question.

ignoreNonPersistents - If true, relation chains that include non-persistent attributes are ignored. If false, these chains are also included in the result.

Returns:

All GraphPath instances representing relation chains to the wanted entity. These paths consist of this instance as the start node and relation AttributeI instances as edges/path elements leading to the wanted entity.