Class SystemEntity
java.lang.Object
com.aquima.interactions.portal.ds.sys.metamodel.SystemEntity
- All Implemented Interfaces:
IReportingDS
,IEntityDS
This class is used to add the system entity to an application. The system entity is added by wrapping the original
meta-model data source, and adding this definition during the entity initialization phase.
- Since:
- 5.0
- Author:
- O. Kerpershoek
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addMessage
(ErrorCode code, String[] parameters, Severity severity) This method will add an initialization error to the report for the specified error code and parameters.This method return the description for this entity.getId()
This method returns the unique identifier of the entity, consisting of the lowercased entity name.getName()
This method returns the unique name of the entity.This method may return the name that should be used when creating a singleton instance for this entity.This method returns the name of the super type of the entity.boolean
This method returns a boolean indicating if the entity definition is abstract, and may only used as super type of other entity definitions.boolean
This method returns a boolean indicating if only a single instance of this type may exist at runtime.void
iterateAttributes
(IAttributeVisitor visitor) This method will be invoked by the meta model component to request the information of all attributes that are defined for this entity.
-
Field Details
-
NAME
- See Also:
-
-
Constructor Details
-
SystemEntity
public SystemEntity()
-
-
Method Details
-
getId
Description copied from interface:IEntityDS
This method returns the unique identifier of the entity, consisting of the lowercased entity name. -
getName
Description copied from interface:IEntityDS
This method returns the unique name of the entity. -
getDescription
Description copied from interface:IEntityDS
This method return the description for this entity.- Specified by:
getDescription
in interfaceIEntityDS
- Returns:
- Return the description for this entity
-
getSingletonName
Description copied from interface:IEntityDS
This method may return the name that should be used when creating a singleton instance for this entity. The name of a singleton is only relevant when isSingleton method returns true.- Specified by:
getSingletonName
in interfaceIEntityDS
- Returns:
- This method returns the name of the singleton instance.
-
getSuperType
Description copied from interface:IEntityDS
This method returns the name of the super type of the entity. When the entity does not have any super type, the method should return a null value.- Specified by:
getSuperType
in interfaceIEntityDS
- Returns:
- name of the super type of this entity
-
isSingleton
public boolean isSingleton()Description copied from interface:IEntityDS
This method returns a boolean indicating if only a single instance of this type may exist at runtime.- Specified by:
isSingleton
in interfaceIEntityDS
- Returns:
- A boolean indicating whether only a single instance of this type may exist at runtime.
-
isAbstract
public boolean isAbstract()Description copied from interface:IEntityDS
This method returns a boolean indicating if the entity definition is abstract, and may only used as super type of other entity definitions. Abstract entities can never be instantiated in the profile. If an entity is defined both abstract and singleton, the profile may hold multiple instances of this type, but each instance of an entity extending this abstract type must be a singleton.- Specified by:
isAbstract
in interfaceIEntityDS
- Returns:
- A boolean indicating if the entity definition is abstract.
-
iterateAttributes
Description copied from interface:IEntityDS
This method will be invoked by the meta model component to request the information of all attributes that are defined for this entity.- Specified by:
iterateAttributes
in interfaceIEntityDS
- Parameters:
visitor
- The visitor that should be used to add the attribute definitions to.
-
addMessage
Description copied from interface:IReportingDS
This method will add an initialization error to the report for the specified error code and parameters.- Specified by:
addMessage
in interfaceIReportingDS
- Parameters:
code
- Error code identifying the message.parameters
- Optional array of parameters for the message.severity
- The severity of the message.
-