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
,org.flowable.common.engine.impl.db.HasRevision
,org.flowable.common.engine.impl.persistence.entity.Entity
public class MasterDataInstanceEntityImpl extends AbstractDataObjectEngineEntity implements MasterDataInstanceEntity
-
Field Summary
Fields Modifier and Type Field Description protected java.util.Date
creationTime
protected java.lang.String
creatorId
protected java.lang.String
definitionId
protected java.lang.String
definitionKey
protected java.lang.String
description
protected java.lang.String
externalId
protected boolean
favorite
protected java.lang.String
key
protected java.lang.String
name
protected java.util.List<DataObjectVariableEntity>
queryVariables
protected int
sortOrder
protected java.lang.String
state
protected java.lang.String
tenantId
protected java.lang.String
updaterId
protected java.util.Date
updateTime
protected java.util.Map<java.lang.String,java.lang.Object>
variables
protected boolean
variablesInitialized
-
Constructor Summary
Constructors Constructor Description MasterDataInstanceEntityImpl()
-
Method Summary
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 byMasterDataInstance.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 benull
.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 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
-
Field Details
-
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 -
queryVariables
-
variablesInitialized
protected boolean variablesInitialized
-
-
Constructor Details
-
MasterDataInstanceEntityImpl
public MasterDataInstanceEntityImpl()
-
-
Method Details
-
getPersistentState
public java.lang.Object getPersistentState()- Specified by:
getPersistentState
in interfaceorg.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 interfaceMasterDataInstance
- Returns:
- the id of the master data definition
-
setDefinitionId
public void setDefinitionId(java.lang.String definitionId)- Specified by:
setDefinitionId
in interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- Returns:
- the key of the master data definition
-
setDefinitionKey
public void setDefinitionKey(java.lang.String definitionKey)- Specified by:
setDefinitionKey
in interfaceMasterDataInstanceEntity
-
getTenantId
public java.lang.String 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
public void setTenantId(java.lang.String tenantId)- Specified by:
setTenantId
in interfaceMasterDataInstanceEntity
-
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 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
public void setExternalId(java.lang.String externalId)- Specified by:
setExternalId
in interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- Returns:
- the key for this master data instance
-
setKey
public void setKey(java.lang.String key)- Specified by:
setKey
in interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- Returns:
- the name of this master data instance
-
setName
public void setName(java.lang.String name)- Specified by:
setName
in interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- Returns:
- the state of this master data instance
- See Also:
for a list of available states
-
setState
public void setState(java.lang.String state)- 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
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 interfaceMasterDataInstance
- Returns:
- the optional description or null, if not present
-
setDescription
public void setDescription(java.lang.String description)- Specified by:
setDescription
in interfaceMasterDataInstanceEntity
-
getCreationTime
public java.util.Date getCreationTime()Description copied from interface:MasterDataInstance
Returns the creation timestamp of this data instance.- Specified by:
getCreationTime
in interfaceMasterDataInstance
- Returns:
- the creation timestamp
-
setCreationTime
public void setCreationTime(java.util.Date creationTime)- Specified by:
setCreationTime
in interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- Returns:
- the id of the creation user
-
setCreatorId
public void setCreatorId(java.lang.String creatorId)- Specified by:
setCreatorId
in interfaceMasterDataInstanceEntity
-
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 benull
.- Specified by:
getUpdateTime
in interfaceMasterDataInstance
- Returns:
- the timestamp of the last update / modification of this data object
-
setUpdateTime
public void setUpdateTime(java.util.Date updateTime)- Specified by:
setUpdateTime
in interfaceMasterDataInstanceEntity
-
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 interfaceMasterDataInstance
- Returns:
- the optional id of the user having last updated this data instance
-
setUpdaterId
public void setUpdaterId(java.lang.String updaterId)- Specified by:
setUpdaterId
in interfaceMasterDataInstanceEntity
-
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 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
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 interfaceMasterDataInstance
- Returns:
- the optional map of variables for this master data instance
-
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
-