Package com.flowable.dataobject.engine.impl.runtime.datasource

Class DataObjectDataDictionarySession.DataObjectObjectModelWithEffectiveFieldMappings

java.lang.Object

com.flowable.dataobject.engine.impl.runtime.datasource.DataObjectDataDictionarySession.DataObjectObjectModelWithEffectiveFieldMappings

All Implemented Interfaces:

DataObjectModel, ServiceRegistryDataObjectModel

Enclosing class:

DataObjectDataDictionarySession

protected static class DataObjectDataDictionarySession.DataObjectObjectModelWithEffectiveFieldMappings
extends Object
implements ServiceRegistryDataObjectModel

A delegate data object model, which is used to hold enriched field mappings derived from the data dictionary information.

Field Summary

Fields

Modifier and Type	Field	Description
protected ServiceRegistryDataObjectModel	delegate
protected List<ServiceRegistryFieldMapping>	effectiveFieldMappings

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataObjectObjectModelWithEffectiveFieldMappings(ServiceRegistryDataObjectModel delegate, List<ServiceRegistryFieldMapping> effectiveFieldMappings)

Method Summary

Modifier and Type	Method	Description
String	getDataDictionaryTypeName()	The type name from the referenced data dictionary model.
String	getDataObjectType()	Returns the data object definition type, which can be for example masterData or dataObject.
DataObjectDefinitionIdentityLinks	getDefinitionIdentityLinks()	The identity links for the data object model.
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.
List<ServiceRegistryFieldMapping>	getFieldMappings()
Boolean	getIgnoreInstancePermissions()	Flag indicating that instance level permissions should not be done for this data object model.
Collection<DataObjectInstanceIdentityLinkModel>	getInstanceIdentityLinks()	The identity links that should be added for every newly created data object instance
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	getReferencedDataDictionaryModelKey()	A data object can have a reference to a data dictionary type to inherit fields.
String	getReferencedServiceDefinitionModelKey()	The key of the service definition model.
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.

Methods inherited from class java.lang.Object

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

Field Details

delegate

protected ServiceRegistryDataObjectModel delegate

effectiveFieldMappings

protected List<ServiceRegistryFieldMapping> effectiveFieldMappings

Constructor Details

DataObjectObjectModelWithEffectiveFieldMappings

protected DataObjectObjectModelWithEffectiveFieldMappings(ServiceRegistryDataObjectModel delegate,
 List<ServiceRegistryFieldMapping> effectiveFieldMappings)

Method Details

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

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

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

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

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

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

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

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

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

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

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

getReferencedDataDictionaryModelKey

public String getReferencedDataDictionaryModelKey()

Description copied from interface: ServiceRegistryDataObjectModel

A data object can have a reference to a data dictionary type to inherit fields.

Specified by:

getReferencedDataDictionaryModelKey in interface ServiceRegistryDataObjectModel

Returns:

the model key of the referenced data dictionary model

getDataDictionaryTypeName

public String getDataDictionaryTypeName()

Description copied from interface: ServiceRegistryDataObjectModel

The type name from the referenced data dictionary model. Inherits (all) fields of the referenced type.

Specified by:

getDataDictionaryTypeName in interface ServiceRegistryDataObjectModel

Returns:

the type name to inherit fields from

getReferencedServiceDefinitionModelKey

public String getReferencedServiceDefinitionModelKey()

Description copied from interface: ServiceRegistryDataObjectModel

The key of the service definition model.

Specified by:

getReferencedServiceDefinitionModelKey in interface ServiceRegistryDataObjectModel

getFieldMappings

public List<ServiceRegistryFieldMapping> getFieldMappings()

Specified by:

getFieldMappings in interface ServiceRegistryDataObjectModel

getDefinitionIdentityLinks

public DataObjectDefinitionIdentityLinks getDefinitionIdentityLinks()

Description copied from interface: ServiceRegistryDataObjectModel

The identity links for the data object model.

Specified by:

getDefinitionIdentityLinks in interface ServiceRegistryDataObjectModel

getInstanceIdentityLinks

public Collection<DataObjectInstanceIdentityLinkModel> getInstanceIdentityLinks()

Description copied from interface: ServiceRegistryDataObjectModel

The identity links that should be added for every newly created data object instance

Specified by:

getInstanceIdentityLinks in interface ServiceRegistryDataObjectModel

getIgnoreInstancePermissions

public Boolean getIgnoreInstancePermissions()

Description copied from interface: ServiceRegistryDataObjectModel

Flag indicating that instance level permissions should not be done for this data object model.

Specified by:

getIgnoreInstancePermissions in interface ServiceRegistryDataObjectModel

Returns:

whether instance level permissions need to be applied