Package com.flowable.dataobject.engine.impl.persistence.entity

Class MasterDataInstanceEntityImpl

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Date getCreationTime()
      Returns the creation timestamp of this data instance.
      java.lang.String getCreatorId()
      Returns the id of the user creating this data instance.
      java.lang.String getDefinitionId()
      Returns the id of the master data definition this instance belongs to.
      java.lang.String getDefinitionKey()
      Returns the key of the master data definition this instance belongs to.
      java.lang.String getDescription()
      Returns the optional description of this master data instance, if any, null otherwise.
      java.lang.String getExternalId()
      Returns the external id of this master data instance.
      java.lang.String getKey()
      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.
      java.lang.String getLocalizedName​(java.util.Locale locale)
      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.
      java.lang.String getName()
      Returns the name of this master data instance which is usually used as the label.
      java.lang.Object getPersistentState()  
      java.util.List<DataObjectVariableEntity> getQueryVariables()
      Getter used by MyBatis when querying master data instances with variables included.
      int getSortOrder()
      Returns the sort order for this master data instance.
      java.lang.String getState()
      Returns the state of this master data instance which might be active or archived.
      java.lang.String getTenantId()
      Returns the tenant id for this master data instance.
      java.lang.String getUpdaterId()
      Returns the optional id of the user having last modified this data instance, if any, null otherwise.
      java.util.Date getUpdateTime()
      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.
      java.util.Map<java.lang.String,​java.lang.Object> getVariables()
      Returns the optional map of variables attached to this master data instance.
      boolean isFavorite()
      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.
      void setCreationTime​(java.util.Date creationTime)  
      void setCreatorId​(java.lang.String creatorId)  
      void setDefinitionId​(java.lang.String definitionId)  
      void setDefinitionKey​(java.lang.String definitionKey)  
      void setDescription​(java.lang.String description)  
      void setExternalId​(java.lang.String externalId)  
      void setFavorite​(boolean favorite)  
      void setKey​(java.lang.String key)  
      void setName​(java.lang.String name)  
      void setQueryVariables​(java.util.List<DataObjectVariableEntity> queryVariables)
      Setter used by MyBatis when querying master data instances with variables.
      void setSortOrder​(int sortOrder)  
      void setState​(java.lang.String state)  
      void setTenantId​(java.lang.String tenantId)  
      void setUpdaterId​(java.lang.String updaterId)  
      void setUpdateTime​(java.util.Date updateTime)  

      • Methods inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity

        getId, getOriginalPersistentState, getRevision, getRevisionNext, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setRevision, setUpdated

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

      • Methods inherited from interface org.flowable.common.engine.impl.persistence.entity.Entity

        getId, getIdPrefix, getOriginalPersistentState, isDeleted, isInserted, isUpdated, setDeleted, setId, setInserted, setOriginalPersistentState, setUpdated

      • Methods inherited from interface org.flowable.common.engine.impl.db.HasRevision

        getRevision, getRevisionNext, setRevision

    • Field Detail

      • definitionId

        protected java.lang.String definitionId

      • definitionKey

        protected java.lang.String definitionKey

      • tenantId

        protected java.lang.String tenantId

      • externalId

        protected java.lang.String externalId

      • key

        protected java.lang.String key

      • name

        protected java.lang.String name

      • state

        protected java.lang.String state

      • sortOrder

        protected int sortOrder

      • favorite

        protected boolean favorite

      • description

        protected java.lang.String description

      • creationTime

        protected java.util.Date creationTime

      • creatorId

        protected java.lang.String creatorId

      • updateTime

        protected java.util.Date updateTime

      • updaterId

        protected java.lang.String updaterId

      • variables

        protected java.util.Map<java.lang.String,​java.lang.Object> variables

      • variablesInitialized

        protected boolean variablesInitialized

    • Constructor Detail

      • MasterDataInstanceEntityImpl

        public MasterDataInstanceEntityImpl()

    • Method Detail

      • getPersistentState

        public java.lang.Object getPersistentState()
        Specified by:
        getPersistentState in interface org.flowable.common.engine.impl.persistence.entity.Entity

      • getDefinitionId

        public java.lang.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

      • getDefinitionKey

        public java.lang.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

      • getTenantId

        public java.lang.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

      • getExternalId

        public java.lang.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

      • getKey

        public java.lang.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

      • getName

        public java.lang.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

      • getState

        public java.lang.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:
        for a list of available states

      • 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

      • 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

      • getDescription

        public java.lang.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

      • getCreationTime

        public java.util.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

      • getCreatorId

        public java.lang.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

      • getUpdateTime

        public java.util.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

      • getUpdaterId

        public java.lang.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

      • getLocalizedName

        public java.lang.String getLocalizedName​(java.util.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 java.util.Map<java.lang.String,​java.lang.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

      • getQueryVariables

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