Class MasterDataInstanceEntityImpl
java.lang.Object
org.flowable.common.engine.impl.persistence.entity.AbstractEntity
com.flowable.dataobject.engine.impl.persistence.entity.AbstractDataObjectEngineEntity
com.flowable.dataobject.engine.impl.persistence.entity.MasterDataInstanceEntityImpl
- All Implemented Interfaces:
MasterDataInstance
,MasterDataInstanceEntity
,HasRevision
,Entity
public class MasterDataInstanceEntityImpl
extends AbstractDataObjectEngineEntity
implements MasterDataInstanceEntity
-
Field Summary
Modifier and TypeFieldDescriptionprotected Date
protected String
protected String
protected String
protected String
protected String
protected boolean
protected String
protected String
protected List<Translation>
protected List<DataObjectVariableEntity>
protected int
protected String
protected String
protected boolean
protected String
protected Date
protected boolean
Fields inherited from class org.flowable.common.engine.impl.persistence.entity.AbstractEntity
id, isDeleted, isInserted, isUpdated, originalPersistentState, revision
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionReturns the creation timestamp of this data instance.Returns the id of the user creating this data instance.Returns the id of the master data definition this instance belongs to.Returns the key of the master data definition this instance belongs to.Returns the optional description of this master data instance, if any, null otherwise.Returns the external id of this master data instance.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.getLocalizedName
(Locale locale) Returns the name for this instance according the given locale, if available, defaults to the name provided byMasterDataInstance.getName()
if there is no translation available for the requested locale.getName()
Returns the name of this master data instance which is usually used as the label.Getter used by MyBatis when querying master data instances with translations included.Getter used by MyBatis when querying master data instances with variables included.int
Returns the sort order for this master data instance.getState()
Returns the state of this master data instance which might be active or archived.Returns the tenant id for this master data instance.The translations for the master data, a Map having locale as the key and key value pairs for each locale.Returns the optional id of the user having last modified this data instance, if any,null
otherwise.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 benull
.Returns the optional map of variables attached to this master data instance.boolean
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
(Date creationTime) void
setCreatorId
(String creatorId) void
setDefinitionId
(String definitionId) void
setDefinitionKey
(String definitionKey) void
setDescription
(String description) void
setExternalId
(String externalId) void
setFavorite
(boolean favorite) void
void
void
setQueryTranslations
(List<Translation> queryVariables) Setter used by MyBatis when querying master data instances with translations.void
setQueryVariables
(List<DataObjectVariableEntity> queryVariables) Setter used by MyBatis when querying master data instances with variables.void
setSortOrder
(int sortOrder) void
void
setTenantId
(String tenantId) void
setUpdaterId
(String updaterId) void
setUpdateTime
(Date updateTime) Methods inherited from class com.flowable.dataobject.engine.impl.persistence.entity.AbstractDataObjectEngineEntity
getIdPrefix
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
Methods inherited from interface com.flowable.dataobject.api.runtime.MasterDataInstance
getId
-
Field Details
-
definitionId
-
definitionKey
-
tenantId
-
externalId
-
key
-
name
-
state
-
sortOrder
protected int sortOrder -
favorite
protected boolean favorite -
description
-
creationTime
-
creatorId
-
updateTime
-
updaterId
-
variables
-
translations
-
queryVariables
-
queryTranslations
-
variablesInitialized
protected boolean variablesInitialized -
translationsInitialized
protected boolean translationsInitialized
-
-
Constructor Details
-
MasterDataInstanceEntityImpl
public MasterDataInstanceEntityImpl()
-
-
Method Details
-
getPersistentState
- Specified by:
getPersistentState
in interfaceEntity
-
getDefinitionId
Description copied from interface:MasterDataInstance
Returns the id of the master data definition this instance belongs to.- Specified by:
getDefinitionId
in interfaceMasterDataInstance
- Returns:
- the id of the master data definition
-
setDefinitionId
- Specified by:
setDefinitionId
in interfaceMasterDataInstanceEntity
-
getDefinitionKey
Description copied from interface:MasterDataInstance
Returns the key of the master data definition this instance belongs to.- Specified by:
getDefinitionKey
in interfaceMasterDataInstance
- Returns:
- the key of the master data definition
-
setDefinitionKey
- Specified by:
setDefinitionKey
in interfaceMasterDataInstanceEntity
-
getTenantId
Description copied from interface:MasterDataInstance
Returns the tenant id for this master data instance.- Specified by:
getTenantId
in interfaceMasterDataInstance
- Returns:
- the tenant id of this master data instance
-
setTenantId
- Specified by:
setTenantId
in interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- 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
- Specified by:
setExternalId
in interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- Returns:
- the key for this master data instance
-
setKey
- Specified by:
setKey
in interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- Returns:
- the name of this master data instance
-
setName
- Specified by:
setName
in interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- Returns:
- the state of this master data instance
- See Also:
-
setState
- Specified by:
setState
in interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- 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 interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- Returns:
- true if this is a favorite master data instance
-
setFavorite
public void setFavorite(boolean favorite) - Specified by:
setFavorite
in interfaceMasterDataInstanceEntity
-
getDescription
Description copied from interface:MasterDataInstance
Returns the optional description of this master data instance, if any, null otherwise.- Specified by:
getDescription
in interfaceMasterDataInstance
- Returns:
- the optional description or null, if not present
-
setDescription
- Specified by:
setDescription
in interfaceMasterDataInstanceEntity
-
getCreationTime
Description copied from interface:MasterDataInstance
Returns the creation timestamp of this data instance.- Specified by:
getCreationTime
in interfaceMasterDataInstance
- Returns:
- the creation timestamp
-
setCreationTime
- Specified by:
setCreationTime
in interfaceMasterDataInstanceEntity
-
getCreatorId
Description copied from interface:MasterDataInstance
Returns the id of the user creating this data instance.- Specified by:
getCreatorId
in interfaceMasterDataInstance
- Returns:
- the id of the creation user
-
setCreatorId
- Specified by:
setCreatorId
in interfaceMasterDataInstanceEntity
-
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 benull
.- Specified by:
getUpdateTime
in interfaceMasterDataInstance
- Returns:
- the timestamp of the last update / modification of this data object
-
setUpdateTime
- Specified by:
setUpdateTime
in interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- Returns:
- the optional id of the user having last updated this data instance
-
setUpdaterId
- Specified by:
setUpdaterId
in interfaceMasterDataInstanceEntity
-
getLocalizedName
Description copied from interface:MasterDataInstance
Returns the name for this instance according the given locale, if available, defaults to the name provided byMasterDataInstance.getName()
if there is no translation available for the requested locale.- Specified by:
getLocalizedName
in interfaceMasterDataInstance
- 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
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 interfaceMasterDataInstance
- Returns:
- the optional map of variables for this master data instance
-
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 interfaceMasterDataInstance
- Returns:
- the translations
-
getQueryVariables
Getter used by MyBatis when querying master data instances with variables included. -
setQueryVariables
Setter used by MyBatis when querying master data instances with variables.- Specified by:
setQueryVariables
in interfaceMasterDataInstanceEntity
-
getQueryTranslations
Getter used by MyBatis when querying master data instances with translations included. -
setQueryTranslations
Setter used by MyBatis when querying master data instances with translations.
-