Package com.flowable.dataobject.api.repository

Interface MasterDataModel

All Superinterfaces:
DataObjectModel
All Known Implementing Classes:
DefaultMasterDataModel
public interface MasterDataModel extends DataObjectModel
The master data model contains all meta information for a single master data definition (type).
Author:
Micha Kiener

  • Method Details

    • getMasterDataSourceId

      String getMasterDataSourceId()
      Returns the id of the source this master data definition and its entries is served from.
      Returns:
      the id of the source for this master data

    • getManagementCapabilities

      Map<String,List<String>> getManagementCapabilities()
      Returns a map containing the capabilities for a management tool defined for this master data definition. The map contains group keys as the key and the list of capability (also named as identity link type) for that group. The information provided by this model are then used to create identity links for this master definition.
      Returns:
      the map containing the management capabilities of this master data definition mapped to groups
      See Also:

    • getFilterParameters

      List<MasterDataFilterParameter> getFilterParameters()
      Returns an optional list of filter parameters needed when looking up entries based on this master data definition.
      Returns:
      the list of filter parameters available for this master data type or an empty list, if none available or needed

    • getDefaultLocale

      String getDefaultLocale()
      Returns the default locale used for resolving default entry names within this master data definition.
      Returns:
      the default locale for this master data definition

    • isSupportsNameFiltering

      boolean isSupportsNameFiltering()
      Returns true if this master data definition supports name filtering for master data entries or false if filtering for names should be done by the DataObjectRepositoryService instead. If this is a master data definition using an external system as its source, it might not support name filtering thus the filtering must be done at service level and cannot be done within the source.
      Returns:
      true if name filtering is supported by this definition, false if filtering should take place on service level

    • getKeyField

      String getKeyField()
      Returns the key field name that references the master data instance

    • getIdField

      String getIdField()
      Returns the id field name that uniquely identifies the master data instance

    • getNameField

      String getNameField()
      Returns the name field name that can be used as a label for the master data instance

    • getVariables

      Map<String,String> getVariables()
      Returns the field name of each additional variable for the master data instance

    • isKeyFieldNumeric

      boolean isKeyFieldNumeric()
      Returns:
      true if the key field should be returned as numeric value instead of a string value.