public interface IEntity extends IUniquelyNamed, Serializable
Interface that defines the run-time shape of an entity
Modifier and Type | Field and Description |
---|---|
static String |
ENTITY_PREFIX |
SEP
Modifier and Type | Method and Description |
---|---|
List<IEntityAttribute> |
getAllAttributesForPhysicalStorage()
The list of all attributes as declared in this entity, all its super
entities and ALL sub-entities.
|
List<IEntity> |
getAllSubEntities() |
IEntityAttribute |
getAttribute(String pAttributeName) |
IAttributeGroup |
getAttributeGroup(String pGroupName)
Deprecated.
use
IFormView and IFormSection instead |
List<IAttributeGroup> |
getAttributeGroups()
Deprecated.
use
IFormView and IFormSection instead |
List<IEntityAttribute> |
getAttributes()
The list of attributes declared in this entity or inherited from its
super entities.
|
IEntity |
getBaseEntity()
Return the top base entity from which this entity inherits.
|
ICheckConstraint |
getCheckConstraint(String pName) |
List<ICheckConstraint> |
getCheckConstraints() |
IConsolidator |
getConsolidator() |
IEntityAttribute |
getDeclaredAttribute(String pAttributeName) |
List<IEntityAttribute> |
getDeclaredAttributes()
The list of attributes declared in this entity (not inherited)
ordered by their position as defined in design model.
|
IFormView |
getDefaultFormView()
|
ITableView |
getDefaultTableView()
Get the default
ITableView for this IEntity . |
List<IEntityAttribute> |
getDNAttributes() |
String |
getDNSeparator() |
IEnricher |
getEnricher(String pName) |
List<IEnricher> |
getEnrichers()
Returns the list of
IEnricher s ordered according to design
position. |
IFormView |
getFormView(String pName)
Return the
IFormView with the given name or throws
NoSuchFormViewException if there is no IFormView with
this name |
List<IFormView> |
getFormViews()
Obtain the list of IFormViews.
|
SemQLMatcher |
getMatcher() |
MatchingBehavior |
getMatchingBehavior()
Return the
MatchingBehavior for this IEntity . |
IModel |
getModel()
Deprecated.
|
String |
getName() |
String |
getPhysicalName() |
IPKAttribute |
getPKAttribute()
Obtain the primary key attribute for this IEntity.
|
IPluginValidator |
getPluginValidator(String pName) |
List<IPluginValidator> |
getPluginValidators() |
IReference |
getReferencedRef(String pReferenceName) |
List<IReference> |
getReferencedRefs()
Return the IReferences where this entity (or one of it's super entities)
is the from entity.
|
IReference |
getReferencingRef(String pReferenceName) |
List<IReference> |
getReferencingRefs()
Return the IReferences where this entity (or one of it's super entities)
is the to entity.
|
ISearchForm |
getSearchForm(String name)
Returns the
ISearchForm owned by this entity, with the given
name. |
Collection<ISearchForm> |
getSearchForms()
Returns
ISearchForm s owned by this entity. |
IEntity |
getSuperEntity() |
ITableView |
getTableView(String pName)
Return the
ITableView with the given name or throws
NoSuchTableViewException if there is no ITableView with
this name |
List<ITableView> |
getTableViews()
Obtain the list of ITableViews.
|
IUniqueKey |
getUniqueKey(String pName) |
List<IUniqueKey> |
getUniqueKeys() |
IDTDataValidation |
getValidation(String pConstraintType,
String pConstraintName)
Retrieve the Constraint
|
List<IDTDataValidation> |
getValidations()
Returns the validationConstraints defined on this entity.
|
boolean |
isFuzzy()
Deprecated.
use
isFuzzyMatched() instead |
boolean |
isFuzzyMatched()
Convenience method equivalent to
getMatchingBehavior() == MatchingBehavior.FUZZY_MATCHING |
boolean |
isI18ned() |
boolean |
isIdMatched()
Convenience method equivalent to
getMatchingBehavior() == MatchingBehavior.FUZZY_MATCHING |
boolean |
isPartOfInheritance()
Returns true if current entity is part of an inheritance hierarchy.
|
boolean |
isSubEntityOf(IEntity pOtherEntity)
Returns true if current entity is the same or is a sub entity of the
pOtherEntity
|
getPrefixedUniqueName, getUniqueName
static final String ENTITY_PREFIX
@Deprecated IModel getModel()
String getName()
String getPhysicalName()
IPKAttribute getPKAttribute()
getSuperEntity()
the IPKAttribute
comes from the base
IEntity
List<IEntityAttribute> getDeclaredAttributes()
getAttributes()
IEntityAttribute getDeclaredAttribute(String pAttributeName) throws NoSuchAttributeException
pAttributeName
- NoSuchAttributeException
- when the attribute name cannot be found or if it is nullList<IEntityAttribute> getAttributes()
IEntityAttribute getAttribute(String pAttributeName) throws NoSuchAttributeException
pAttributeName
- NoSuchAttributeException
- when the attribute name cannot be found or if it is nullList<IEntityAttribute> getAllAttributesForPhysicalStorage()
getAttributes()
IEntity getSuperEntity()
List<IEntity> getAllSubEntities()
boolean isSubEntityOf(IEntity pOtherEntity)
pOtherEntity
- boolean isI18ned()
List<IReference> getReferencingRefs()
IReference getReferencingRef(String pReferenceName) throws NoSuchReferenceException
pReferenceName
- NoSuchReferenceException
- if this reference is not foundList<IReference> getReferencedRefs()
IReference getReferencedRef(String pReferenceName) throws NoSuchReferenceException
pReferenceName
- NoSuchReferenceException
- if this reference is not foundList<IEntityAttribute> getDNAttributes()
String getDNSeparator()
@Deprecated List<IAttributeGroup> getAttributeGroups()
@Deprecated IAttributeGroup getAttributeGroup(String pGroupName) throws NoSuchAttributeGroupException
pGroupName
- NoSuchAttributeGroupException
List<ICheckConstraint> getCheckConstraints()
ICheckConstraint getCheckConstraint(String pName) throws NoSuchCheckConstraintException
NoSuchCheckConstraintException
List<IUniqueKey> getUniqueKeys()
IUniqueKey getUniqueKey(String pName) throws NoSuchUniqueKeyException
NoSuchUniqueKeyException
List<IEnricher> getEnrichers()
IEnricher
s ordered according to design
position.IEnricher getEnricher(String pName) throws NoSuchEnricherException
NoSuchEnricherException
SemQLMatcher getMatcher()
IConsolidator getConsolidator()
List<IPluginValidator> getPluginValidators()
IPluginValidator getPluginValidator(String pName) throws NoSuchPluginValidatorException
NoSuchPluginValidatorException
List<ITableView> getTableViews()
ITableView
names.ITableView getTableView(String pName) throws NoSuchTableViewException
ITableView
with the given name or throws
NoSuchTableViewException
if there is no ITableView
with
this namepName
- NoSuchTableViewException
ITableView getDefaultTableView()
ITableView
for this IEntity
.List<IFormView> getFormViews()
IFormView
names.IFormView getFormView(String pName) throws NoSuchFormViewException
IFormView
with the given name or throws
NoSuchFormViewException
if there is no IFormView
with
this namepName
- NoSuchFormViewException
Collection<ISearchForm> getSearchForms()
ISearchForm
s owned by this entity.Collection
of ISearchForm
sISearchForm getSearchForm(String name) throws NoSuchSearchFormException
ISearchForm
owned by this entity, with the given
name.name
- the search form nameISearchForm
with provided nameNoSuchSearchFormException
- if no search form with provided name is foundIFormView getDefaultFormView()
MatchingBehavior getMatchingBehavior()
MatchingBehavior
for this IEntity
.@Deprecated boolean isFuzzy()
isFuzzyMatched()
insteadboolean isFuzzyMatched()
getMatchingBehavior()
== MatchingBehavior.FUZZY_MATCHING
boolean isIdMatched()
getMatchingBehavior()
== MatchingBehavior.FUZZY_MATCHING
IEntity getBaseEntity()
getSuperEntity()
)
it returns itself.boolean isPartOfInheritance()
List<IDTDataValidation> getValidations()
IMandatoryValidation
: Mandatory Attributes Constraints
(including mandatory IForeignAttribute)
ILovValidation
: Value constraint for attributes with ILov
Type
ICheckValidation
: Custom SemQL constraint based on
ICheckConstraint
IForeignKeyValidation
: Constraint based on IReference
IUniqueKeyValidation
: Unique Key constraint based on
IUniqueKey
IPluginValidation
constraint: constraint based on plugin
IPluginValidator
IDTDataValidation getValidation(String pConstraintType, String pConstraintName) throws NoSuchConstraintException
pConstraintType
- pConstraintName
- NoSuchConstraintException
Copyright © 2017. All rights reserved.