Package com.flowable.dataobject.api.repository

Interface DataObjectModel

All Known Subinterfaces:
MasterDataModel, ServiceRegistryDataObjectModel
All Known Implementing Classes:
BaseDataObjectModel, BaseServiceRegistryDataObjectModel, DefaultMasterDataModel
public interface DataObjectModel
The data object model contains all meta information around a data object like source, fields behaviour and further information.
Author:
Micha Kiener

  • Method Summary

    Modifier and Type Method Description
    java.lang.String getDataObjectType()
    Returns the data object definition type, which can be for example masterData or dataObject.
    java.lang.String getDescription()
    Returns the optional description of this data object definition which might contain additional information around the data objects described by this definition.
    java.lang.String getExternalId()
    Returns the optional external id for this data object definition, if any, otherwise null will be returned.
    java.lang.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.
    java.lang.String getName()
    Returns the name of this data object definition which is usually used as the label.
    java.lang.String getSourceId()
    Returns the id of the source for this data object definition.
    java.util.Map<java.lang.String,​java.lang.Object> getSourceSpecificAttributes()
    Returns a map of source specific attributes for this data object model.
    java.lang.String getSourceType()
    Returns the type of the source for this data object definition.
    java.lang.String getSubType()
    The sub type further categorizes this data object definition (see type for more information and examples).
    java.lang.String getSupportedCachingType()
    Returns the supported caching type for the master data entries based on this definition.
    java.lang.String getType()
    The type of this data object definition, normally used to kind of categorize data object definitions (e.g.

  • Method Details

    • getKey

      java.lang.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.
      Returns:
      the key for this data object definition

    • getName

      java.lang.String getName()
      Returns the name of this data object definition which is usually used as the label.
      Returns:
      the name of this data object definition

    • getDataObjectType

      java.lang.String getDataObjectType()
      Returns the data object definition type, which can be for example masterData or dataObject.
      Returns:
      the data object type of this data object definition
      See Also:
      for a list of supported types

    • getDescription

      java.lang.String getDescription()
      Returns the optional description of this data object definition which might contain additional information around the data objects described by this definition.
      Returns:
      the optional description of the master data definition, might be null

    • getType

      java.lang.String getType()
      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.
      Returns:
      the type of this data object definition

    • getSubType

      java.lang.String getSubType()
      The sub type further categorizes this data object definition (see type for more information and examples).
      Returns:
      the sub type of this data object description

    • getSourceId

      java.lang.String getSourceId()
      Returns the id of the source for this data object definition.
      Returns:
      the id of the source supporting this data objects

    • getSourceType

      java.lang.String getSourceType()
      Returns the type of the source for this data object definition.
      Returns:
      the type of the source supporting this data objects
      See Also:
      for a list of supported source types

    • getExternalId

      java.lang.String getExternalId()
      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.
      Returns:
      the optional external id for this data object definition or null if none available

    • getSupportedCachingType

      java.lang.String getSupportedCachingType()
      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.
      Returns:
      the supported caching type
      See Also:
      for a list of supported caching types

    • getSourceSpecificAttributes

      java.util.Map<java.lang.String,​java.lang.Object> getSourceSpecificAttributes()
      Returns a map of source specific attributes for this data object model. The attributes are depending on the data source handling this data object.
      Returns:
      the optional map of data source specific attributes