de.ipcon.schema

Class EntityWrapper

java.lang.Object

de.ipcon.schema.EntityWrapper

All Implemented Interfaces:

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

Direct Known Subclasses:

InstrumentingEntity

public class EntityWrapper
extends java.lang.Object
implements EntityI

Nested Class Summary

Nested classes/interfaces inherited from interface de.ipcon.schema.EntityI

EntityI.EntityMatcher, EntityI.NonPersistentEdgeFilter

Field Summary

Fields inherited from interface de.ipcon.schema.EntityI

ATT_NAME_ABSTRACT, ATT_NAME_CODE_CUSTOM, ATT_NAME_CODE_DEPENDENTS, ATT_NAME_CODE_GENERATE, ATT_NAME_CODE_GENERATE_AS, ATT_NAME_CODE_PACKAGE, ATT_NAME_DB_FORBID_DIRECT_CHANGES, ATT_NAME_DB_LOW_INSTANCE_COUNT, ATT_NAME_DB_NAME, ATT_NAME_DB_NO_STREAM_RESOURCE_HISTORY, ATT_NAME_DB_PERSISTENT, ATT_NAME_DB_STREAM_RESOURCE, ATT_NAME_DISCRIMINATOR, ATT_NAME_EXPORT_MODE, ATT_NAME_EXPORT_NAME, ATT_NAME_EXPORT_PRIMARY_KEY, ATT_NAME_EXTENDS, ATT_NAME_FOLDER, ATT_NAME_FULLTEXT_BOOST, ATT_NAME_FULLTEXT_INDEXED, ATT_NAME_GDPR_DATA_CATEGORY, ATT_NAME_GDPR_RETENTION_START_DATE_PATH, ATT_NAME_IGNORE_REVERSE_RELATIONS, ATT_NAME_IMPLEMENTS_NAME, ATT_NAME_LOOKUP_DEFAULT_CASE_SENSITIVE, ATT_NAME_LOOKUP_DEFAULT_PROPERTY, ATT_NAME_LOOKUP_DEFAULT_SUBSTRING, ATT_NAME_MERGE, ATT_NAME_NAME, ATT_NAME_NO_ABSTRACT_WARNING, ATT_NAME_PACKAGE, ATT_NAME_PLURAL, ATT_NAME_REPORT_FONT_SIZE_BIG, ATT_NAME_REPORT_FONT_SIZE_NORMAL, ATT_NAME_REPORT_ORIENTATION, ATT_NAME_REPORT_TITLE, ATT_NAME_SUID, ATT_NAME_UI_DEFAULT_SELECTION_FILTER, ATT_NAME_UI_DEFAULT_SORTING, ATT_NAME_UI_DESCRIPTION, ATT_NAME_UI_LINK_ONLY, ATT_NAME_UI_LOAD_IMMEDIATE, ATT_NAME_UI_TIPS, DEFAULT_GENERATE_AS_SUFFIX, DEFAULT_SORTING_ASC, DEFAULT_SORTING_DESC, DEPENDENTS_SEPARATOR_CHAR, EL_NAME_ACTION, EL_NAME_ATTR, EL_NAME_CODE, EL_NAME_COMMENT, EL_NAME_DB, EL_NAME_EXPORT, EL_NAME_FULLTEXT, EL_NAME_GDPR, EL_NAME_IMPLEMENTS, EL_NAME_LOOKUP, EL_NAME_NPATTR, EL_NAME_REPORT, EL_NAME_UI, EL_NAME_VATTR, EMPTY_ARRAY, EXPORT_MODE_IF_REFERENCED, EXPORT_MODE_LIST, EXPORT_MODE_NEVER, EXPORT_MODE_SINGLE, GENERATE_AS_DELIMITER_CHAR, PREFIX_L10N_KEY, RESERVED_TABLE_NAMES, SUFFIX_L10N_PLURAL_KEY

Fields inherited from interface de.ipcon.schema.StructuredEntityI

$01

Fields inherited from interface de.ipcon.schema.BasicEntityI

log

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
int	compareTo(java.lang.Object o)
java.util.List	getActionList()
java.util.List	getAttributeList() Returns a List with the AttributeI-s added by/defined exactly on this CBOEntity.
EntityI	getBaseEntity()
java.util.List	getClassesUpToPreviousEntity()
java.lang.Class	getClazz() Returns the Class object representing this entity.
java.util.Set<java.lang.String>	getCustomClassInModulesOrProject()
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, recursively 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.String	getDescription() Returns the description String of this BasicEntityI instance or of the first base BasicEntityI that has a description.
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	getFolderName() Returns the folder name of this BasicEntityI as used in the navigation tree in the GUI.
java.lang.String	getFQName()
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.
java.util.Collection<SchemaInterfaceI>	getImplementedSchemaInterfaces() Return all implemented interfaces as SchemaInterfaceI objects, from which further information may be obtained.
java.util.Collection<SchemaInterfaceI>	getImplementedSchemaInterfaces(boolean checkBaseEntities)
java.lang.Boolean	getIndexedForFTS()
java.lang.String	getL10nName() Returns the localized singular name of this entity.
java.lang.String	getL10nName(boolean _returnKeyWhenNotFound) Returns the localized singular name of this entity, with configurable fallback behavior.
java.lang.String	getL10nNameKey() Returns the localization key for the singular name of this entity.
java.lang.String	getL10nNameVar() Returns a localizable String variable reference for the singular name of this entity.
java.lang.String	getL10nPlural() Returns the localized plural name of this entity.
java.lang.String	getL10nPlural(boolean _returnKeyWhenNotFound) Returns the localized plural name of this entity, with configurable fallback behavior.
java.lang.String	getL10nPluralKey() Returns the localization key for the plural name of this entity.
java.lang.String	getL10nPluralVar() Returns a localizable String variable reference for the plural name of this entity.
java.lang.Boolean	getLinkOnly() Checks if the linkOnly-flag is set for this EntityI or one of its base EntityI-s.
java.util.Set<java.lang.String>	getModulePackages() Returns the names of the module packages this BasicEntityI is appearing in.
java.lang.String	getName() Returns the name of this BasicEntityI instance.
java.util.Set<java.lang.String>	getOrCreateCustomClassInModulesOrProjectSet()
java.util.Set<java.lang.String>	getOrCreateModulePackagesSet() Returns the names of the modules this BasicEntityI is appearing in.
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.lang.String	getPlural()
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()
SchemaI	getSchema()
AttributeI	getSingleAttribute(java.lang.String attName) Returns the AttributeI for the specified name, which must match either the plural or singular form.
java.util.List	getSubEntityList() return a List of EntityI containing every EntityI that has this StructuredEntityI as StructuredEntityI.getBaseEntity().
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	hasSubEntities()
boolean	isCustom()
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	isPersistent()
boolean	isStreamResource()
boolean	isSubEntityOf(StructuredEntityI possibleSuperEntity) Returns true if we are a subentity of the given EntityI or that StructuredEntityI ourself.
boolean	isUserAbstract()
BOI	newInstance() Builds and returns a fitting new object implementing BOI that has the current BasicEntityI as entity.
java.lang.String	parametersToString()
EntityI	realEntity()
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 d) 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.
java.lang.String	toString()
static EntityI	unwrap(EntityI entity)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.ipcon.schema.EntityI

findReachableAttrsWithType, findReachableAttrsWithType, getFromNodes, getIncomingEdges, getOutgoingEdges, getToNodes, getToolTipTextForAttribute, isCoreEntity, isCoreEntityClass, isCoreEntityPackageName, isCoreNative, isModuleNative, isPartOfModule, isProjectEntity, isProjectEntityClass, isProjectEntityPackageName, isProjectNative, toEntities

Methods inherited from interface de.ipcon.schema.StructuredEntityI

filterAttributes, getAllAttributeList, getAllAttributeList, getAllAttributeList, getAllAttributeListByType, getAllAttributeListByType, getAllAttributeListByType, getAllAttributeListByType, getAllAttributeListWithoutSubentities, getAllAttributeListWithoutSubentities, getAllCoreAttributeList, getAllModuleAttributeList, getAllProjectAttributeList, getAllSubEntityList, getAllSubEntityList, getAllSubEntityList, getAttChain, getAttChain, getAttribute, getAttribute, getPersistentBaseEntity, hasPersistentSubentity, isEffectivelyPersistent, isImplicitlyPersistent, isSubEntityOf

Methods inherited from interface de.ipcon.schema.BasicEntityI

getAttributeListByType, getAttributeListByType, getCurrentModuleOrProject, getRelations, isCustom

Method Detail

realEntity

public EntityI realEntity()

getGDPRPolicy

public GDPRPolicy getGDPRPolicy()

Specified by:

getGDPRPolicy in interface EntityI

unwrap

public static EntityI unwrap(EntityI entity)

getSchema

public SchemaI getSchema()

Specified by:

getSchema in interface BasicEntityI

newInstance

public BOI newInstance()

Description copied from interface: BasicEntityI

Builds and returns a fitting new object implementing BOI that has the current BasicEntityI as entity.

Specified by:

newInstance in interface BasicEntityI

Returns:

a fitting new object implementing BOI that has the current BasicEntityI as entity.

getName

public java.lang.String getName()

Description copied from interface: BasicEntityI

Returns the name of this BasicEntityI instance. Can also be used for querying objects of that kind in OQL queries.

Specified by:

getName in interface BasicEntityI

Returns:

the name of this BasicEntityI instance.

getPackage

public java.lang.String getPackage()

Description copied from interface: EntityI

Returns the package of the current EntityI

Specified by:

getPackage in interface EntityI

Returns:

the package of the current EntityI

getPackageAsPath

public java.lang.String getPackageAsPath()

Description copied from interface: EntityI

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

Specified by:

getPackageAsPath in interface EntityI

Returns:

a relative file system path based off the package

getPlural

public java.lang.String getPlural()

Specified by:

getPlural in interface BasicEntityI

Returns:

the plural name of this BasicEntityI instance.

getDescription

public java.lang.String getDescription()

Description copied from interface: BasicEntityI

Returns the description String of this BasicEntityI instance or of the first base BasicEntityI that has a description. Falls back to the name of this BasicEntityI with appended Id in brackets. Used for formatting BOs having this BasicEntityI as type.

Specified by:

getDescription in interface BasicEntityI

Returns:

the description String of this BasicEntityI instance or of the first base BasicEntityI that has a description.

getFQName

public java.lang.String getFQName()

Specified by:

getFQName in interface EntityI

Returns:

the fully qualified name of this EntityI

getFolderName

public java.lang.String getFolderName()

Description copied from interface: BasicEntityI

Returns the folder name of this BasicEntityI as used in the navigation tree in the GUI.

Specified by:

getFolderName in interface BasicEntityI

Returns:

The folder name.

getOrCreateCustomClassInModulesOrProjectSet

public java.util.Set<java.lang.String> getOrCreateCustomClassInModulesOrProjectSet()

Specified by:

getOrCreateCustomClassInModulesOrProjectSet in interface BasicEntityI

getCustomClassInModulesOrProject

public java.util.Set<java.lang.String> getCustomClassInModulesOrProject()

Specified by:

getCustomClassInModulesOrProject in interface BasicEntityI

getOrCreateModulePackagesSet

public java.util.Set<java.lang.String> getOrCreateModulePackagesSet()

Description copied from interface: BasicEntityI

Returns the names of the modules this BasicEntityI is appearing in. Creates and sets a new set if none exists yet.

Specified by:

getOrCreateModulePackagesSet in interface BasicEntityI

Returns:

The names of the modules this BasicEntityI is appearing in.

getModulePackages

public java.util.Set<java.lang.String> getModulePackages()

Description copied from interface: BasicEntityI

Returns the names of the module packages this BasicEntityI is appearing in.

Specified by:

getModulePackages in interface BasicEntityI

Returns:

The names of the module packages this BasicEntityI is appearing in.

isStreamResource

public boolean isStreamResource()

Specified by:

isStreamResource in interface EntityI

Returns:

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

isNoStreamResourceHistory

public boolean isNoStreamResourceHistory()

Specified by:

isNoStreamResourceHistory in interface EntityI

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

isUserAbstract

public boolean isUserAbstract()

Specified by:

isUserAbstract in interface BasicEntityI

Returns:

true if this BasicEntityI is defined as abstract in the schema.

isPersistent

public boolean isPersistent()

Specified by:

isPersistent in interface BasicEntityI

Returns:

true if this BasicEntityI is defined as persistent in the schema.

isForbidDirectChanges

public boolean isForbidDirectChanges()

Specified by:

isForbidDirectChanges in interface EntityI

Returns:

true if direct changes to objects with this EntityI are forbidden

getClazz

public java.lang.Class getClazz()

Description copied from interface: BasicEntityI

Returns the Class object representing this entity.

Specified by:

getClazz in interface BasicEntityI

Returns:

The Class object for this entity.

getClassesUpToPreviousEntity

public java.util.List getClassesUpToPreviousEntity()

Specified by:

getClassesUpToPreviousEntity in interface EntityI

Returns:

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

getPersistenceAspectClass

public java.lang.Class getPersistenceAspectClass()

Description copied from interface: EntityI

Returns the generateAs-class for the current EntityI

Specified by:

getPersistenceAspectClass in interface EntityI

Returns:

the generateAs-class for the current EntityI

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable

getL10nNameKey

public java.lang.String getL10nNameKey()

Description copied from interface: EntityI

Returns the localization key for the singular name of this entity. The key is typically constructed by prepending EntityI.PREFIX_L10N_KEY to a canonicalized version of the entity's name (obtained via L10n.stringToKey(getName())).

Specified by:

getL10nNameKey in interface EntityI

Returns:

The localization key for the entity's singular name.

getL10nNameVar

public java.lang.String getL10nNameVar()

Description copied from interface: EntityI

Returns a localizable String variable reference for the singular name of this entity. This reference is typically formatted as "$R{'KEY'}", where 'KEY' is the value obtained from EntityI.getL10nNameKey(). This format is typically used in UI or template systems to dynamically load localized strings.

Specified by:

getL10nNameVar in interface EntityI

Returns:

The localizable String variable reference for the entity's singular name.

getL10nName

public java.lang.String getL10nName()

Description copied from interface: EntityI

Returns the localized singular name of this entity. If no localization is found, the localization key itself is returned as a fallback. This method is a convenience wrapper for EntityI.getL10nName(boolean) with fallback enabled.

Specified by:

getL10nName in interface EntityI

Returns:

The localized singular name of this entity.

getL10nName

public java.lang.String getL10nName(boolean _returnKeyWhenNotFound)

Description copied from interface: EntityI

Returns the localized singular name of this entity, with configurable fallback behavior. This method typically uses L10n.msg(String, Object[], Object[], boolean, String) to retrieve the translation, passing this entity as a participant in the lookup path.

Specified by:

getL10nName in interface EntityI

Parameters:

_returnKeyWhenNotFound - If true, the localization key will be returned if no matching translation is found. If false, null is returned in that case.

Returns:

The localized singular name of this entity.

getL10nPluralKey

public java.lang.String getL10nPluralKey()

Description copied from interface: EntityI

Returns the localization key for the plural name of this entity. The key is typically constructed by combining EntityI.PREFIX_L10N_KEY, a canonicalized version of the entity's name, and EntityI.SUFFIX_L10N_PLURAL_KEY.

Specified by:

getL10nPluralKey in interface EntityI

Returns:

The localization key for the entity's plural name.

getL10nPluralVar

public java.lang.String getL10nPluralVar()

Description copied from interface: EntityI

Returns a localizable String variable reference for the plural name of this entity. This reference is typically formatted as "$R{'KEY'}", where 'KEY' is the value obtained from EntityI.getL10nPluralKey(). This format is typically used in UI or template systems to dynamically load localized plural strings.

Specified by:

getL10nPluralVar in interface EntityI

Returns:

The localizable String variable reference for the entity's plural name.

getL10nPlural

public java.lang.String getL10nPlural()

Description copied from interface: EntityI

Returns the localized plural name of this entity. If no localization is found, the localization key itself is returned as a fallback. This method is a convenience wrapper for EntityI.getL10nPlural(boolean) with fallback enabled.

Specified by:

getL10nPlural in interface EntityI

Returns:

The localized plural name of this entity.

getL10nPlural

public java.lang.String getL10nPlural(boolean _returnKeyWhenNotFound)

Description copied from interface: EntityI

Returns the localized plural name of this entity, with configurable fallback behavior. This method constructs the plural localization key dynamically (typically by combining EntityI.PREFIX_L10N_KEY, getName(), and EntityI.SUFFIX_L10N_PLURAL_KEY) and typically uses L10n.msg(String, Object[], Object[], boolean, String) to retrieve the translation, passing this entity as a participant in the lookup path.

Specified by:

getL10nPlural in interface EntityI

Parameters:

_returnKeyWhenNotFound - If true, the constructed localization key will be returned if no matching translation is found. If false, null is returned in that case.

Returns:

The localized plural name of this entity.

getImplementedSchemaInterfaces

public java.util.Collection<SchemaInterfaceI> getImplementedSchemaInterfaces()

Description copied from interface: BasicEntityI

Return all implemented interfaces as SchemaInterfaceI objects, from which further information may be obtained.

Specified by:

getImplementedSchemaInterfaces in interface BasicEntityI

Returns:

all implemented interfaces as SchemaInterfaceI objects.

getImplementedSchemaInterfaces

public java.util.Collection<SchemaInterfaceI> getImplementedSchemaInterfaces(boolean checkBaseEntities)

Specified by:

getImplementedSchemaInterfaces in interface BasicEntityI

getSingleAttribute

public AttributeI getSingleAttribute(java.lang.String attName)

Description copied from interface: BasicEntityI

Returns the AttributeI for the specified name, which must match either the plural or singular form.

Specified by:

getSingleAttribute in interface BasicEntityI

Parameters:

attName - The name to get the AttributeI for.

Returns:

The AttributeI for the specified name.

getAttributeList

public java.util.List getAttributeList()

Description copied from interface: BasicEntityI

Returns a List with the AttributeI-s added by/defined exactly on this CBOEntity. Excludes inherited Attributes.

Specified by:

getAttributeList in interface BasicEntityI

Returns:

A List of attributes specific to this CBOEntity.

getActionList

public java.util.List getActionList()

Specified by:

getActionList in interface EntityI

Returns:

a List containing all possible CBOAction-s of this EntityI

getValue

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

Description copied from interface: EntityI

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.

Specified by:

getValue in interface EntityI

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

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

Description copied from interface: EntityI

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.

Specified by:

getValueAsString in interface EntityI

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

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

Description copied from interface: EntityI

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

Specified by:

setValue in interface EntityI

Parameters:

bo - the bo to set the given value in

attPath - the path to the attribute to set

value - the value to set

setValueAsString

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

Description copied from interface: EntityI

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

Specified by:

setValueAsString in interface EntityI

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

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

Description copied from interface: EntityI

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

Specified by:

setValueAsString in interface EntityI

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

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

Description copied from interface: EntityI

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

Specified by:

getRelationObjects in interface EntityI

Parameters:

bo - the bo to get relations for

attName - the attribute to get relations for

Returns:

the relations map for the attribute

addRelationObject

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

Description copied from interface: EntityI

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

Specified by:

addRelationObject in interface EntityI

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

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

Description copied from interface: EntityI

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

Specified by:

removeRelationObject in interface EntityI

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

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

Description copied from interface: EntityI

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

Specified by:

hasRelationObject in interface EntityI

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

isSubEntityOf

public boolean isSubEntityOf(StructuredEntityI possibleSuperEntity)

Description copied from interface: StructuredEntityI

Returns true if we are a subentity of the given EntityI or that StructuredEntityI ourself.

Specified by:

isSubEntityOf in interface StructuredEntityI

Parameters:

possibleSuperEntity - the EntityI to check

Returns:

true if we are a subentity of the given EntityI or that StructuredEntityI ourself.

getBaseEntity

public EntityI getBaseEntity()

Specified by:

getBaseEntity in interface StructuredEntityI

Returns:

the base (i.e. super-) EntityI of this EntityI

hasSubEntities

public boolean hasSubEntities()

Specified by:

hasSubEntities in interface StructuredEntityI

Returns:

true if this EntityI has sub entities

getSubEntityList

public java.util.List getSubEntityList()

Description copied from interface: StructuredEntityI

return a List of EntityI containing every EntityI that has this StructuredEntityI as StructuredEntityI.getBaseEntity(). Does not include this StructuredEntityI or transitive sub-EntityI-s.

Specified by:

getSubEntityList in interface StructuredEntityI

hasGuiTip

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

Description copied from interface: EntityI

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.

Specified by:

hasGuiTip in interface EntityI

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

public boolean hasGuiTip(java.lang.String tip)

Description copied from interface: EntityI

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

Specified by:

hasGuiTip in interface EntityI

Parameters:

tip - the key to check

Returns:

true if a tip with the given key exists

getGuiTip

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

Description copied from interface: EntityI

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.

Specified by:

getGuiTip in interface EntityI

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

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

Description copied from interface: EntityI

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

Specified by:

getGuiTip in interface EntityI

Parameters:

tip - the key for the tip to return

Returns:

the gui tip for the given key

getGuiTipAsInt

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

Description copied from interface: EntityI

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.

Specified by:

getGuiTipAsInt in interface EntityI

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

getGuiTipAsInt

public int getGuiTipAsInt(java.lang.String tip)

Description copied from interface: EntityI

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

Specified by:

getGuiTipAsInt in interface EntityI

Parameters:

tip - the key for the tip to return

Returns:

the gui tip as int for the given key

isLinkOnly

public boolean isLinkOnly()

Description copied from interface: EntityI

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!

Specified by:

isLinkOnly in interface EntityI

Returns:

true if the linkOnly-flag is set

getLinkOnly

public java.lang.Boolean getLinkOnly()

Description copied from interface: EntityI

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!

Specified by:

getLinkOnly in interface EntityI

Returns:

Boolean.TRUE if the linkOnly-flag is set

isLoadImmediate

public boolean isLoadImmediate()

Specified by:

isLoadImmediate in interface EntityI

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

public java.lang.String getDefaultLookupProperty()

Specified by:

getDefaultLookupProperty in interface EntityI

Returns:

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

getDefaultLookupSubstring

public java.lang.Boolean getDefaultLookupSubstring()

Specified by:

getDefaultLookupSubstring in interface EntityI

Returns:

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

getDefaultLookupStartingWith

public java.lang.Boolean getDefaultLookupStartingWith()

Specified by:

getDefaultLookupStartingWith in interface EntityI

Returns:

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

getDefaultLookupCaseSensitive

public java.lang.Boolean getDefaultLookupCaseSensitive()

Specified by:

getDefaultLookupCaseSensitive in interface EntityI

Returns:

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

getDefaultSorting

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

Description copied from interface: EntityI

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

Specified by:

getDefaultSorting in interface EntityI

Returns:

the defaultSorting for the current EntityI as Map

getDefaultSortDirection

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

Description copied from interface: EntityI

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

Specified by:

getDefaultSortDirection in interface EntityI

Parameters:

path - the path of the DefaultSortDefinitionEntry in defaultSorting

Returns:

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

getDefaultSortLevel

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

Description copied from interface: EntityI

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

Specified by:

getDefaultSortLevel in interface EntityI

Parameters:

path - the path of the DefaultSortDefinitionEntry in defaultSorting

Returns:

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

getDefaultSelectionFilter

public java.lang.String getDefaultSelectionFilter()

Description copied from interface: EntityI

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.

Specified by:

getDefaultSelectionFilter in interface EntityI

Returns:

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

getReportTitle

public java.lang.String getReportTitle()

Specified by:

getReportTitle in interface EntityI

Returns:

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

getReportOrientation

public java.lang.String getReportOrientation()

Specified by:

getReportOrientation in interface EntityI

Returns:

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

getReportFontSizeNormal

public java.lang.Integer getReportFontSizeNormal()

Specified by:

getReportFontSizeNormal in interface EntityI

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

public java.lang.Integer getReportFontSizeBig()

Specified by:

getReportFontSizeBig in interface EntityI

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

public java.util.List<ExportDefinitionEntry> getExports()

Description copied from interface: EntityI

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

Specified by:

getExports in interface EntityI

Returns:

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

getExports

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

Description copied from interface: EntityI

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

Specified by:

getExports in interface 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

public ExportDefinitionEntry getExport(java.lang.String name)

Description copied from interface: EntityI

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

Specified by:

getExport in interface EntityI

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

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

Description copied from interface: EntityI

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

Specified by:

getExport in interface EntityI

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.

isCustom

public boolean isCustom()

Specified by:

isCustom in interface BasicEntityI

Returns:

true, if this BasicEntityI has a custom implementation and not only generated code

getDependentClasses

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

Specified by:

getDependentClasses in interface EntityI

Returns:

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

setDiscriminator

public void setDiscriminator(java.lang.Long d)

Description copied from interface: EntityI

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

Specified by:

setDiscriminator in interface EntityI

Parameters:

d - the id to set as discriminator

getDiscriminator

public java.lang.Long getDiscriminator()

Specified by:

getDiscriminator in interface EntityI

Returns:

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

getIndexedForFTS

public java.lang.Boolean getIndexedForFTS()

Specified by:

getIndexedForFTS in interface EntityI

Returns:

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

getFTSBoost

public java.lang.Float getFTSBoost()

Specified by:

getFTSBoost in interface EntityI

Returns:

a Float indicating the fulltext search boost parameter for this EntityI

parametersToString

public java.lang.String parametersToString()

Specified by:

parametersToString in interface EntityI

toString

public java.lang.String toString()

Specified by:

toString in interface EntityI

Overrides:

toString in class java.lang.Object

Returns:

a String containing all information about the current EntityI