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 java.lang.Object
implements DataObjectModel

  • Field Summary

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

  • Constructor Summary

    Constructors 
    Constructor Description
    BaseDataObjectModel()  

  • 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.
    void setDataObjectType​(java.lang.String dataObjectType)  
    void setDescription​(java.lang.String description)  
    void setExternalId​(java.lang.String externalId)  
    void setKey​(java.lang.String key)  
    void setName​(java.lang.String name)  
    void setSourceId​(java.lang.String sourceId)  
    void setSourceSpecificAttributes​(java.util.Map<java.lang.String,​java.lang.Object> sourceSpecificAttributes)  
    void setSourceType​(java.lang.String sourceType)  
    void setSubType​(java.lang.String subType)  
    void setSupportedCachingType​(java.lang.String supportedCachingType)  
    void setType​(java.lang.String type)  

    Methods inherited from class java.lang.Object

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

  • Field Details

    • key

      protected java.lang.String key

    • name

      protected java.lang.String name

    • dataObjectType

      protected java.lang.String dataObjectType

    • description

      protected java.lang.String description

    • type

      protected java.lang.String type

    • subType

      protected java.lang.String subType

    • sourceId

      protected java.lang.String sourceId

    • sourceType

      protected java.lang.String sourceType

    • externalId

      protected java.lang.String externalId

    • supportedCachingType

      protected java.lang.String supportedCachingType

    • sourceSpecificAttributes

      protected java.util.Map<java.lang.String,​java.lang.Object> sourceSpecificAttributes

  • Constructor Details

  • Method Details

    • getKey

      public java.lang.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​(java.lang.String key)

    • getName

      public java.lang.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​(java.lang.String name)

    • getDataObjectType

      public java.lang.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​(java.lang.String dataObjectType)

    • getDescription

      public java.lang.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​(java.lang.String description)

    • getType

      public java.lang.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​(java.lang.String type)

    • getSubType

      public java.lang.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​(java.lang.String subType)

    • getSourceId

      public java.lang.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​(java.lang.String sourceId)

    • getSourceType

      public java.lang.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​(java.lang.String sourceType)

    • getExternalId

      public java.lang.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​(java.lang.String externalId)

    • getSupportedCachingType

      public java.lang.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​(java.lang.String supportedCachingType)

    • getSourceSpecificAttributes

      public java.util.Map<java.lang.String,​java.lang.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​(java.util.Map<java.lang.String,​java.lang.Object> sourceSpecificAttributes)