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()
java.lang.String	getDescription() Returns the description String of this EntityI instance or of the first base EntityI that has a description.
java.lang.String	getFolderName() Returns the folder name of this EntityI 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.lang.String	getName() Returns the name of this EntityI instance.
java.lang.String	getPlural()
default java.util.List<AttributeI>	getRelations() Returns a list of all relational attributes defined on this EntityI, 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()
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 EntityI instance. Can also be used for querying objects of that kind in OQL queries.

Returns:

the name of this EntityI instance.

getPlural

java.lang.String getPlural()

Returns:

the plural name of this EntityI instance.

getDescription

java.lang.String getDescription()

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

Returns:

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

getClazz

java.lang.Class getClazz()

Returns:

the Class representing this EntityI

Throws:

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

isUserAbstract

boolean isUserAbstract()

Returns:

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

isPersistent

boolean isPersistent()

Returns:

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

isCustom

boolean isCustom()

Returns:

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

getFolderName

java.lang.String getFolderName()

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

Returns:

The folder name.

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 EntityI, including virtual ones. Inherited attributes are excluded.

Returns:

A list of relational attributes specific to this EntityI.

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.