Class MasterDataInstanceEntityImpl

All Implemented Interfaces:
MasterDataInstance, MasterDataInstanceEntity, HasRevision, Entity

public class MasterDataInstanceEntityImpl extends AbstractDataObjectEngineEntity implements MasterDataInstanceEntity
  • Field Details

    • definitionId

      protected String definitionId
    • definitionKey

      protected String definitionKey
    • tenantId

      protected String tenantId
    • externalId

      protected String externalId
    • key

      protected String key
    • name

      protected String name
    • state

      protected String state
    • sortOrder

      protected int sortOrder
    • favorite

      protected boolean favorite
    • description

      protected String description
    • creationTime

      protected Date creationTime
    • creatorId

      protected String creatorId
    • updateTime

      protected Date updateTime
    • updaterId

      protected String updaterId
    • variables

      protected Map<String,Object> variables
    • translations

      protected Map<String,Map<String,String>> translations
    • queryVariables

      protected List<DataObjectVariableEntity> queryVariables
    • queryTranslations

      protected List<Translation> queryTranslations
    • variablesInitialized

      protected boolean variablesInitialized
    • translationsInitialized

      protected boolean translationsInitialized
  • Constructor Details

    • MasterDataInstanceEntityImpl

      public MasterDataInstanceEntityImpl()
  • Method Details

    • getPersistentState

      public Object getPersistentState()
      Specified by:
      getPersistentState in interface Entity
    • getDefinitionId

      public String getDefinitionId()
      Description copied from interface: MasterDataInstance
      Returns the id of the master data definition this instance belongs to.
      Specified by:
      getDefinitionId in interface MasterDataInstance
      Returns:
      the id of the master data definition
    • setDefinitionId

      public void setDefinitionId(String definitionId)
      Specified by:
      setDefinitionId in interface MasterDataInstanceEntity
    • getDefinitionKey

      public String getDefinitionKey()
      Description copied from interface: MasterDataInstance
      Returns the key of the master data definition this instance belongs to.
      Specified by:
      getDefinitionKey in interface MasterDataInstance
      Returns:
      the key of the master data definition
    • setDefinitionKey

      public void setDefinitionKey(String definitionKey)
      Specified by:
      setDefinitionKey in interface MasterDataInstanceEntity
    • getTenantId

      public String getTenantId()
      Description copied from interface: MasterDataInstance
      Returns the tenant id for this master data instance.
      Specified by:
      getTenantId in interface MasterDataInstance
      Returns:
      the tenant id of this master data instance
    • setTenantId

      public void setTenantId(String tenantId)
      Specified by:
      setTenantId in interface MasterDataInstanceEntity
    • getExternalId

      public String getExternalId()
      Description copied from interface: MasterDataInstance
      Returns the external id of this master data instance. This is specially useful, if this master data instance is mastered within an external system and needs to be mapped to that external id. The external id must be unique only within the same master data type, not fully unique like the normal, technical id. If this master data instance is, however, managed internally, the external id might simply return the same value as the id.
      Specified by:
      getExternalId in interface MasterDataInstance
      Returns:
      the external id or the same value as MasterDataInstance.getId() if this data object is managed internally and not by an external data source
    • setExternalId

      public void setExternalId(String externalId)
      Specified by:
      setExternalId in interface MasterDataInstanceEntity
    • getKey

      public String getKey()
      Description copied from interface: MasterDataInstance
      Returns the key for this master data instance which must be unique, but is human-readable normally and must be the same across environments for the same master data instance. For a country master data instance, this might for instance be the 3 digit ISO code.
      Specified by:
      getKey in interface MasterDataInstance
      Returns:
      the key for this master data instance
    • setKey

      public void setKey(String key)
      Specified by:
      setKey in interface MasterDataInstanceEntity
    • getName

      public String getName()
      Description copied from interface: MasterDataInstance
      Returns the name of this master data instance which is usually used as the label.
      Specified by:
      getName in interface MasterDataInstance
      Returns:
      the name of this master data instance
    • setName

      public void setName(String name)
      Specified by:
      setName in interface MasterDataInstanceEntity
    • getState

      public String getState()
      Description copied from interface: MasterDataInstance
      Returns the state of this master data instance which might be active or archived. An archived instance must not be selected or presented for lookup anymore, but must still be available as it might still be referenced by some data in the system.
      Specified by:
      getState in interface MasterDataInstance
      Returns:
      the state of this master data instance
      See Also:
    • setState

      public void setState(String state)
      Specified by:
      setState in interface MasterDataInstanceEntity
    • getSortOrder

      public int getSortOrder()
      Description copied from interface: MasterDataInstance
      Returns the sort order for this master data instance. Entries having the same sort order will be sorted according their names, but sometimes sorting according the name is not what you want (for instance priority levels should be sorted according there severity, not their name).
      Specified by:
      getSortOrder in interface MasterDataInstance
      Returns:
      the sort order for this master data instance, defaults to 0, if not set
    • setSortOrder

      public void setSortOrder(int sortOrder)
      Specified by:
      setSortOrder in interface MasterDataInstanceEntity
    • isFavorite

      public boolean isFavorite()
      Description copied from interface: MasterDataInstance
      Returns true, if this master data instance is a favorite, which means it should be shown on the top of the list in a selection for instance.
      Specified by:
      isFavorite in interface MasterDataInstance
      Returns:
      true if this is a favorite master data instance
    • setFavorite

      public void setFavorite(boolean favorite)
      Specified by:
      setFavorite in interface MasterDataInstanceEntity
    • getDescription

      public String getDescription()
      Description copied from interface: MasterDataInstance
      Returns the optional description of this master data instance, if any, null otherwise.
      Specified by:
      getDescription in interface MasterDataInstance
      Returns:
      the optional description or null, if not present
    • setDescription

      public void setDescription(String description)
      Specified by:
      setDescription in interface MasterDataInstanceEntity
    • getCreationTime

      public Date getCreationTime()
      Description copied from interface: MasterDataInstance
      Returns the creation timestamp of this data instance.
      Specified by:
      getCreationTime in interface MasterDataInstance
      Returns:
      the creation timestamp
    • setCreationTime

      public void setCreationTime(Date creationTime)
      Specified by:
      setCreationTime in interface MasterDataInstanceEntity
    • getCreatorId

      public String getCreatorId()
      Description copied from interface: MasterDataInstance
      Returns the id of the user creating this data instance.
      Specified by:
      getCreatorId in interface MasterDataInstance
      Returns:
      the id of the creation user
    • setCreatorId

      public void setCreatorId(String creatorId)
      Specified by:
      setCreatorId in interface MasterDataInstanceEntity
    • getUpdateTime

      public Date getUpdateTime()
      Description copied from interface: MasterDataInstance
      Returns the timestamp of the last update of this data instance, in most cases where events are immutable, this timestamp is the same as the creation timestamp, but must never be null.
      Specified by:
      getUpdateTime in interface MasterDataInstance
      Returns:
      the timestamp of the last update / modification of this data object
    • setUpdateTime

      public void setUpdateTime(Date updateTime)
      Specified by:
      setUpdateTime in interface MasterDataInstanceEntity
    • getUpdaterId

      public String getUpdaterId()
      Description copied from interface: MasterDataInstance
      Returns the optional id of the user having last modified this data instance, if any, null otherwise.
      Specified by:
      getUpdaterId in interface MasterDataInstance
      Returns:
      the optional id of the user having last updated this data instance
    • setUpdaterId

      public void setUpdaterId(String updaterId)
      Specified by:
      setUpdaterId in interface MasterDataInstanceEntity
    • getLocalizedName

      public String getLocalizedName(Locale locale)
      Description copied from interface: MasterDataInstance
      Returns the name for this instance according the given locale, if available, defaults to the name provided by MasterDataInstance.getName() if there is no translation available for the requested locale.
      Specified by:
      getLocalizedName in interface MasterDataInstance
      Parameters:
      locale - the locale to return the name for
      Returns:
      the name in the requested locale, if available, otherwise the default one is returned
    • getVariables

      public Map<String,Object> getVariables()
      Description copied from interface: MasterDataInstance
      Returns the optional map of variables attached to this master data instance. Returns an empty map, if there are no variables available, but never null.
      Specified by:
      getVariables in interface MasterDataInstance
      Returns:
      the optional map of variables for this master data instance
    • getTranslations

      public Map<String,Map<String,String>> getTranslations()
      Description copied from interface: MasterDataInstance
      The translations for the master data, a Map having locale as the key and key value pairs for each locale.
      Specified by:
      getTranslations in interface MasterDataInstance
      Returns:
      the translations
    • getQueryVariables

      public List<DataObjectVariableEntity> getQueryVariables()
      Getter used by MyBatis when querying master data instances with variables included.
    • setQueryVariables

      public void setQueryVariables(List<DataObjectVariableEntity> queryVariables)
      Setter used by MyBatis when querying master data instances with variables.
      Specified by:
      setQueryVariables in interface MasterDataInstanceEntity
    • getQueryTranslations

      public List<Translation> getQueryTranslations()
      Getter used by MyBatis when querying master data instances with translations included.
    • setQueryTranslations

      public void setQueryTranslations(List<Translation> queryVariables)
      Setter used by MyBatis when querying master data instances with translations.