Package com.flowable.dataobject.api.repository

Class BaseDataObjectModel

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 Details

    • 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 Details

    • BaseDataObjectModel

      public BaseDataObjectModel()

  • 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

    • 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:

    • 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:

    • 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:

    • 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)