Package overit.geocall.edm.model

Class Entity

java.lang.Object
overit.geocall.edm.model.Entity
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AccountEntity, AccountTypeEntity, AssetEntity, AssetTypeEntity, MaterialEntity, ResourceEntity, UserEntity, UserTypeEntity, WorkOrderHeaderEntity, WorkOrderOperationEntity, WorkOrderOperationTypeEntity, WorkOrderTypeEntity
public abstract class Entity extends Object implements Serializable
An abstract class representing a data entity model in the Entity-Data-Model (EDM).
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    Entity.Anonymous
    Useful annotation for marking an entity as anonymous, meaning without a primary key field.
    static @interface 
    Entity.Code
    Annotation used to set the field of the table containing a code capable of uniquely identifying each record (useful during the export of the system configuration).
    static @interface 
    Entity.Description
    Annotation used to set a description for the entity
    static @interface 
    Entity.Final
    Useful annotation for marking an entity as final, meaning it cannot be extended via the EDM framework.
    static @interface 
    Entity.Name
    Annotation used to set the name of the entity.
    static @interface 
    Entity.Pool
    Annotation used to set the name of the pool.
    static @interface 
    Entity.System
    Useful annotation to mark an entity as a system entity, meaning not segregated by company.
    static @interface 
    Entity.Table
    Annotation used to bind an entity to a specific table.
    static @interface 
    Entity.TimeZoneResolver
    Annotation used to set the TimeZoneResolver.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Entity()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    String
    getAcronym()
    Returns a String about the acronym value set for this entity.
    String
    getCode()
    Returns a String about the field of the table containing a code capable of uniquely identifying each record (useful during the export of the system configuration).
    String
    getCompanyIdField()
    Returns a String about the field of the table in which is stored the company ID value associated with the entity model.
    String
    getDescription()
    Retrieves the description of the entity model.
    String
    getExtensionColumn()
    Retrieves the extension column associated with the entity model.
    String
    getId()
    Returns a String about the primary key field of the associated table.
    CustomLayer
    getLayer()
    Retrieves the custom layer associated with the entity model.
    String
    getName()
    Retrieves the name of the entity model.
    String
    getPool()
    Retrieves the pool associated with the entity model.
    String
    getTable()
    Retrieves the table associated with the entity model.
    Class<? extends overit.geocall.timezone.service.TimeZoneResolver>
    getTimeZoneResolver()
    Retrieves the Class<?
    int
    hashCode()
     
    boolean
    isAnonymous()
    Returns true in case this entity has been marked as anonymous; false otherwise.
    boolean
    isFinal()
    Returns true in case this entity has been marked as final (meaning it cannot be extended via the EDM framework); false otherwise.
    boolean
    isSystem()
    Returns true in case this entity has been marked as a system entity (meaning not segregated by company); false otherwise.
    String
    toString()
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Entity

      protected Entity()

  • Method Details

    • getLayer

      public CustomLayer getLayer()
      Retrieves the custom layer associated with the entity model.
      Returns:
      The custom layer associated with the entity model.

    • getName

      public String getName()
      Retrieves the name of the entity model.
      Returns:
      The name of the entity model, or null if the name annotation is not present.

    • getDescription

      public String getDescription()
      Retrieves the description of the entity model.
      Returns:
      The description of the entity model, or null if the description annotation is not present.

    • getTable

      public String getTable()
      Retrieves the table associated with the entity model.
      Returns:
      The table associated with the entity model, or null if the table annotation is not present.

    • getExtensionColumn

      public String getExtensionColumn()
      Retrieves the extension column associated with the entity model.
      Returns:
      The extension column associated with the entity model, or null if the extension column annotation is not present.

    • getPool

      public String getPool()
      Retrieves the pool associated with the entity model.
      Returns:
      The pool associated with the entity model, or the default value "Pool" if the pool annotation is not present.

    • getTimeZoneResolver

      public Class<? extends overit.geocall.timezone.service.TimeZoneResolver> getTimeZoneResolver()
      Retrieves the Class<? extends TimeZoneResolver associated with the entity model.
      Returns:
      The Class<? extends TimeZoneResolver associated with the entity model.

    • getAcronym

      public String getAcronym()
      Returns a String about the acronym value set for this entity.
      Returns:
      a String about the acronym value set for this entity.
      See Also:

    • isAnonymous

      public boolean isAnonymous()
      Returns true in case this entity has been marked as anonymous; false otherwise.
      Returns:
      true in case this entity has been marked as anonymous; false otherwise.
      See Also:

    • isFinal

      public boolean isFinal()
      Returns true in case this entity has been marked as final (meaning it cannot be extended via the EDM framework); false otherwise.
      Returns:
      true in case this entity has been marked as final (meaning it cannot be extended via the EDM framework); false otherwise.
      See Also:

    • isSystem

      public boolean isSystem()
      Returns true in case this entity has been marked as a system entity (meaning not segregated by company); false otherwise.
      Returns:
      true in case this entity has been marked as a system entity (meaning not segregated by company); false otherwise.
      See Also:

    • getId

      public String getId()
      Returns a String about the primary key field of the associated table.
      Returns:
      a String about the primary key field of the associated table.

    • getCompanyIdField

      public String getCompanyIdField()
      Returns a String about the field of the table in which is stored the company ID value associated with the entity model.
      Returns:
      a String about the field of the table in which is stored the company ID value associated with the entity model.

    • getCode

      public String getCode()
      Returns a String about the field of the table containing a code capable of uniquely identifying each record (useful during the export of the system configuration).
      Returns:
      a String about the field of the table containing a code capable of uniquely identifying each record (useful during the export of the system configuration).

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object