de.ipcon.schema

Interface BasicEntityI

All Known Subinterfaces:

EntityI, StructuredEntityI

All Known Implementing Classes:

CBOEntity, EntityDefinition, EntityWrapper, InstrumentingEntity, VirtualEntity

public interface BasicEntityI

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	$0

Method Summary

Modifier and Type	Method and Description
java.util.List<AttributeI>	getAttributeList() Returns a List with the AttributeI-s added by/defined exactly on this CBOEntity.
default java.util.List<AttributeI>	getAttributeListByType() Filters the list of attributes obtained from getAttributeList to the persistent ones.
default java.util.List<AttributeI>	getAttributeListByType(boolean virtual) Filters the list of attributes obtained from getAttributeList based on the specified type (virtual or persistent).
java.lang.Class	getClazz() Returns the Class object representing this entity.
default java.lang.String	getCurrentModuleOrProject()
java.util.Set<java.lang.String>	getCustomClassInModulesOrProject()
java.lang.String	getDescription() Returns the description String of this BasicEntityI instance or of the first base BasicEntityI that has a description.
java.lang.String	getFolderName() Returns the folder name of this BasicEntityI as used in the navigation tree in the GUI.
java.util.Collection<SchemaInterfaceI>	getImplementedSchemaInterfaces() Return all implemented interfaces as SchemaInterfaceI objects, from which further information may be obtained.
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	getPlural()
default java.util.List<AttributeI>	getRelations() Returns a list of all relational attributes defined on this BasicEntityI, including virtual ones.
SchemaI	getSchema()
AttributeI	getSingleAttribute(java.lang.String attName) Returns the AttributeI for the specified name, which must match either the plural or singular form.
boolean	isCustom()
default boolean	isCustom(java.lang.String moduleOrProject)
boolean	isPersistent()
boolean	isUserAbstract()
default BOI	newInstance() Builds and returns a fitting new object implementing BOI that has the current BasicEntityI as entity.

Field Detail

$0

static final java.lang.String $0

See Also:

Constant Field Values

Method Detail

newInstance

default BOI newInstance()

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

Returns:

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

Throws:

CanNotInstantiateObjectException - if the new instance could not be instantiated

getSchema

SchemaI getSchema()

getName

java.lang.String getName()

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

Returns:

the name of this BasicEntityI instance.

getPlural

java.lang.String getPlural()

Returns:

the plural name of this BasicEntityI instance.

getDescription

java.lang.String getDescription()

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.

Returns:

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

getClazz

java.lang.Class getClazz()

Returns the Class object representing this entity.

Returns:

The Class object for this entity.

Throws:

java.lang.ClassNotFoundException - if no Class was found for the fully qualified name of this entity.

isUserAbstract

boolean isUserAbstract()

Returns:

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

isPersistent

boolean isPersistent()

Returns:

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

isCustom

boolean isCustom()

Returns:

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

isCustom

default boolean isCustom(java.lang.String moduleOrProject)

Returns:

true, if this BasicEntityI has a custom implementation in the module with the passed name or in the project, if the passed name is the project package.

getFolderName

java.lang.String getFolderName()

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

Returns:

The folder name.

getOrCreateCustomClassInModulesOrProjectSet

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

getCustomClassInModulesOrProject

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

getCurrentModuleOrProject

default java.lang.String getCurrentModuleOrProject()

getOrCreateModulePackagesSet

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

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

Returns:

The names of the modules this BasicEntityI is appearing in.

getModulePackages

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

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

Returns:

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

getImplementedSchemaInterfaces

java.util.Collection<SchemaInterfaceI> getImplementedSchemaInterfaces()

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

Returns:

all implemented interfaces as SchemaInterfaceI objects.

getSingleAttribute

AttributeI getSingleAttribute(java.lang.String attName)

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

Parameters:

attName - The name to get the AttributeI for.

Returns:

The AttributeI for the specified name.

Throws:

java.lang.IllegalArgumentException - If the passed name is null.

getRelations

default java.util.List<AttributeI> getRelations()

Returns a list of all relational attributes defined on this BasicEntityI, including virtual ones. Inherited attributes are excluded.

Returns:

A list of relational attributes specific to this BasicEntityI.

getAttributeList

java.util.List<AttributeI> getAttributeList()

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

Returns:

A List of attributes specific to this CBOEntity.

getAttributeListByType

default java.util.List<AttributeI> getAttributeListByType()

Filters the list of attributes obtained from getAttributeList to the persistent ones.

Returns:

A filtered list of persistent attributes.

getAttributeListByType

default java.util.List<AttributeI> getAttributeListByType(boolean virtual)

Filters the list of attributes obtained from getAttributeList based on the specified type (virtual or persistent).

Parameters:

virtual - If true, only virtual AttributeI-s are included; if false, only persistent AttributeI-s are included.

Returns:

A filtered list of attributes of the specified type.