BaseDataObjectModel (Flowable Work 3.10.0)

java.lang.Object
- com.flowable.dataobject.api.repository.BaseDataObjectModel

All Implemented Interfaces:

DataObjectModel

Direct Known Subclasses:

BaseServiceRegistryDataObjectModel, DefaultMasterDataModel
```
public class BaseDataObjectModel
extends Object
implements DataObjectModel
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`dataObjectType`
`protected String`	`description`
`protected String`	`externalId`
`protected String`	`key`
`protected String`	`name`
`protected String`	`sourceId`
`protected Map<String,Object>`	`sourceSpecificAttributes`
`protected String`	`sourceType`
`protected String`	`subType`
`protected String`	`supportedCachingType`
`protected String`	`type`

Constructor Summary

Constructors
Constructor and Description

BaseDataObjectModel()

Constructors
Constructor and Description
`BaseDataObjectModel()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getDataObjectType()` Returns the data object definition type, which can be for example masterData or dataObject.
`String`	`getDescription()` Returns the optional description of this data object definition which might contain additional information around the data objects described by this definition.
`String`	`getExternalId()` Returns the optional external id for this data object definition, if any, otherwise null will be returned.
`String`	`getKey()` Returns the key for this data object definition which must be unique, but is human-readable normally and must be the same across environments for the same data object definition.
`String`	`getName()` Returns the name of this data object definition which is usually used as the label.
`String`	`getSourceId()` Returns the id of the source for this data object definition.
`Map<String,Object>`	`getSourceSpecificAttributes()` Returns a map of source specific attributes for this data object model.
`String`	`getSourceType()` Returns the type of the source for this data object definition.
`String`	`getSubType()` The sub type further categorizes this data object definition (see type for more information and examples).
`String`	`getSupportedCachingType()` Returns the supported caching type for the master data entries based on this definition.
`String`	`getType()` The type of this data object definition, normally used to kind of categorize data object definitions (e.g.
`void`	`setDataObjectType(String dataObjectType)`
`void`	`setDescription(String description)`
`void`	`setExternalId(String externalId)`
`void`	`setKey(String key)`
`void`	`setName(String name)`
`void`	`setSourceId(String sourceId)`
`void`	`setSourceSpecificAttributes(Map<String,Object> sourceSpecificAttributes)`
`void`	`setSourceType(String sourceType)`
`void`	`setSubType(String subType)`
`void`	`setSupportedCachingType(String supportedCachingType)`
`void`	`setType(String type)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - key
```
protected String key
```
  - name
```
protected String name
```
  - dataObjectType
```
protected String dataObjectType
```
  - description
```
protected String description
```
  - type
```
protected String type
```
  - subType
```
protected String subType
```
  - sourceId
```
protected String sourceId
```
  - sourceType
```
protected String sourceType
```
  - externalId
```
protected String externalId
```
  - supportedCachingType
```
protected String supportedCachingType
```
  - sourceSpecificAttributes
```
protected Map<String,Object> sourceSpecificAttributes
```
- Constructor Detail
  - BaseDataObjectModel
```
public BaseDataObjectModel()
```
- Method Detail
  - getKey
```
public String getKey()
```
    Description copied from interface: DataObjectModel
    
    Returns the key for this data object definition which must be unique, but is human-readable normally and must be the same across environments for the same data object definition.
    
    Specified by:
    
    getKey in interface DataObjectModel
    
    Returns:
    
    the key for this data object definition
  - setKey
```
public void setKey(String key)
```
  - getName
```
public String getName()
```
    Description copied from interface: DataObjectModel
    
    Returns the name of this data object definition which is usually used as the label.
    
    Specified by:
    
    getName in interface DataObjectModel
    
    Returns:
    
    the name of this data object definition
  - setName
```
public void setName(String name)
```
  - getDataObjectType
```
public String getDataObjectType()
```
    Description copied from interface: DataObjectModel
    
    Returns the data object definition type, which can be for example masterData or dataObject.
    
    Specified by:
    
    getDataObjectType in interface DataObjectModel
    
    Returns:
    
    the data object type of this data object definition
    
    See Also:
    
    for a list of supported types
  - setDataObjectType
```
public void setDataObjectType(String dataObjectType)
```
  - getDescription
```
public String getDescription()
```
    Description copied from interface: DataObjectModel
    
    Returns the optional description of this data object definition which might contain additional information around the data objects described by this definition.
    
    Specified by:
    
    getDescription in interface DataObjectModel
    
    Returns:
    
    the optional description of the master data definition, might be null
  - setDescription
```
public void setDescription(String description)
```
  - getType
```
public String getType()
```
    Description copied from interface: DataObjectModel
    
    The type of this data object definition, normally used to kind of categorize data object definitions (e.g. the type might be 'masterData' and the sub type might then reflect another sub type of master data like 'internal' or 'SAP' or whatever makes sense for categorization.
    
    Specified by:
    
    getType in interface DataObjectModel
    
    Returns:
    
    the type of this data object definition
  - setType
```
public void setType(String type)
```
  - getSubType
```
public String getSubType()
```
    Description copied from interface: DataObjectModel
    
    The sub type further categorizes this data object definition (see type for more information and examples).
    
    Specified by:
    
    getSubType in interface DataObjectModel
    
    Returns:
    
    the sub type of this data object description
  - setSubType
```
public void setSubType(String subType)
```
  - getSourceId
```
public String getSourceId()
```
    Description copied from interface: DataObjectModel
    
    Returns the id of the source for this data object definition.
    
    Specified by:
    
    getSourceId in interface DataObjectModel
    
    Returns:
    
    the id of the source supporting this data objects
  - setSourceId
```
public void setSourceId(String sourceId)
```
  - getSourceType
```
public String getSourceType()
```
    Description copied from interface: DataObjectModel
    
    Returns the type of the source for this data object definition.
    
    Specified by:
    
    getSourceType in interface DataObjectModel
    
    Returns:
    
    the type of the source supporting this data objects
    
    See Also:
    
    for a list of supported source types
  - setSourceType
```
public void setSourceType(String sourceType)
```
  - getExternalId
```
public String getExternalId()
```
    Description copied from interface: DataObjectModel
    
    Returns the optional external id for this data object definition, if any, otherwise null will be returned. You can use the external id to map anything you need if this data object definition is actually referencing an external system source.
    
    Specified by:
    
    getExternalId in interface DataObjectModel
    
    Returns:
    
    the optional external id for this data object definition or null if none available
  - setExternalId
```
public void setExternalId(String externalId)
```
  - getSupportedCachingType
```
public String getSupportedCachingType()
```
    Description copied from interface: DataObjectModel
    
    Returns the supported caching type for the master data entries based on this definition. This is typically helpful for external sources of master data but can also be used for internally managed data to support mem based caching for instance.
    
    Specified by:
    
    getSupportedCachingType in interface DataObjectModel
    
    Returns:
    
    the supported caching type
    
    See Also:
    
    for a list of supported caching types
  - setSupportedCachingType
```
public void setSupportedCachingType(String supportedCachingType)
```
  - getSourceSpecificAttributes
```
public Map<String,Object> getSourceSpecificAttributes()
```
    Description copied from interface: DataObjectModel
    
    Returns a map of source specific attributes for this data object model. The attributes are depending on the data source handling this data object.
    
    Specified by:
    
    getSourceSpecificAttributes in interface DataObjectModel
    
    Returns:
    
    the optional map of data source specific attributes
  - setSourceSpecificAttributes
```
public void setSourceSpecificAttributes(Map<String,Object> sourceSpecificAttributes)
```

Class BaseDataObjectModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

key

name

dataObjectType

description

type

subType

sourceId

sourceType

externalId

supportedCachingType

sourceSpecificAttributes

Constructor Detail

BaseDataObjectModel

Method Detail

getKey

setKey

getName

setName

getDataObjectType

setDataObjectType

getDescription

setDescription

getType

setType

getSubType

setSubType

getSourceId

setSourceId

getSourceType

setSourceType

getExternalId

setExternalId

getSupportedCachingType

setSupportedCachingType

getSourceSpecificAttributes

setSourceSpecificAttributes