java.lang.Object
- com.flowable.dataobject.api.repository.BaseDataObjectModel
- - com.flowable.dataobject.api.repository.DefaultMasterDataModel

All Implemented Interfaces:: DataObjectModel, MasterDataModel

public class DefaultMasterDataModel
extends BaseDataObjectModel
implements MasterDataModel

Field Summary

Fields
Modifier and Type	Field	Description
`protected String`	`defaultLocale`
`protected List<MasterDataFilterParameter>`	`filterParameters`
`protected String`	`idField`
`protected String`	`keyField`
`protected Map<String,List<String>>`	`managementCapabilities`
`protected String`	`masterDataSourceId`
`protected String`	`nameField`
`protected boolean`	`supportsNameFiltering`
`protected Map<String,String>`	`variables`

Fields inherited from class com.flowable.dataobject.api.repository.BaseDataObjectModel
dataObjectType, description, externalId, key, name, sourceId, sourceSpecificAttributes, sourceType, subType, supportedCachingType, type

Constructor Summary

Constructors
Constructor Description

DefaultMasterDataModel()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDefaultLocale()`	Returns the default locale used for resolving default entry names within this master data definition.
`List<MasterDataFilterParameter>`	`getFilterParameters()`	Returns an optional list of filter parameters needed when looking up entries based on this master data definition.
`String`	`getIdField()`	Returns the id field name that uniquely identifies the master data instance
`String`	`getKeyField()`	Returns the key field name that references the master data instance
`Map<String,List<String>>`	`getManagementCapabilities()`	Returns a map containing the capabilities for a management tool defined for this master data definition.
`String`	`getMasterDataSourceId()`	Returns the id of the source this master data definition and its entries is served from.
`String`	`getNameField()`	Returns the name field name that can be used as a label for the master data instance
`Map<String,String>`	`getVariables()`	Returns the field name of each additional variable for the master data instance
`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.
`void`	`setDefaultLocale(String defaultLocale)`
`void`	`setFilterParameters(List<MasterDataFilterParameter> filterParameters)`
`void`	`setIdField(String idField)`
`void`	`setKeyField(String keyField)`
`void`	`setManagementCapabilities(Map<String,List<String>> managementCapabilities)`
`void`	`setMasterDataSourceId(String masterDataSourceId)`
`void`	`setNameField(String nameField)`
`void`	`setSupportsNameFiltering(boolean supportsNameFiltering)`
`void`	`setVariables(Map<String,String> variables)`

Methods inherited from class com.flowable.dataobject.api.repository.BaseDataObjectModel
getDataObjectType, getDescription, getExternalId, getKey, getName, getSourceId, getSourceSpecificAttributes, getSourceType, getSubType, getSupportedCachingType, getType, setDataObjectType, setDescription, setExternalId, setKey, setName, setSourceId, setSourceSpecificAttributes, setSourceType, setSubType, setSupportedCachingType, setType

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.flowable.dataobject.api.repository.DataObjectModel
getDataObjectType, getDescription, getExternalId, getKey, getName, getSourceId, getSourceSpecificAttributes, getSourceType, getSubType, getSupportedCachingType, getType

- Field Detail
  - masterDataSourceId
```
protected String masterDataSourceId
```
  - managementCapabilities
```
protected Map<String,List<String>> managementCapabilities
```
  - filterParameters
```
protected List<MasterDataFilterParameter> filterParameters
```
  - defaultLocale
```
protected String defaultLocale
```
  - supportsNameFiltering
```
protected boolean supportsNameFiltering
```
  - keyField
```
protected String keyField
```
  - idField
```
protected String idField
```
  - nameField
```
protected String nameField
```
  - variables
```
protected Map<String,String> variables
```
- Constructor Detail
  - DefaultMasterDataModel
```
public DefaultMasterDataModel()
```
- Method Detail
  - getMasterDataSourceId
```
public String getMasterDataSourceId()
```
    Description copied from interface: MasterDataModel
    
    Returns the id of the source this master data definition and its entries is served from.
    
    Specified by:
    
    getMasterDataSourceId in interface MasterDataModel
    
    Returns:
    
    the id of the source for this master data
  - setMasterDataSourceId
```
public void setMasterDataSourceId(String masterDataSourceId)
```
  - getManagementCapabilities
```
public Map<String,List<String>> getManagementCapabilities()
```
    Description copied from interface: MasterDataModel
    
    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.
    
    Specified by:
    
    getManagementCapabilities in interface MasterDataModel
    
    Returns:
    
    the map containing the management capabilities of this master data definition mapped to groups
    
    See Also:
    
    for a list of available and supported types
  - setManagementCapabilities
```
public void setManagementCapabilities(Map<String,List<String>> managementCapabilities)
```
  - getFilterParameters
```
public List<MasterDataFilterParameter> getFilterParameters()
```
    Description copied from interface: MasterDataModel
    
    Returns an optional list of filter parameters needed when looking up entries based on this master data definition.
    
    Specified by:
    
    getFilterParameters in interface MasterDataModel
    
    Returns:
    
    the list of filter parameters available for this master data type or an empty list, if none available or needed
  - setFilterParameters
```
public void setFilterParameters(List<MasterDataFilterParameter> filterParameters)
```
  - getDefaultLocale
```
public String getDefaultLocale()
```
    Description copied from interface: MasterDataModel
    
    Returns the default locale used for resolving default entry names within this master data definition.
    
    Specified by:
    
    getDefaultLocale in interface MasterDataModel
    
    Returns:
    
    the default locale for this master data definition
  - setDefaultLocale
```
public void setDefaultLocale(String defaultLocale)
```
  - isSupportsNameFiltering
```
public boolean isSupportsNameFiltering()
```
    Description copied from interface: MasterDataModel
    
    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.
    
    Specified by:
    
    isSupportsNameFiltering in interface MasterDataModel
    
    Returns:
    
    true if name filtering is supported by this definition, false if filtering should take place on service level
  - setSupportsNameFiltering
```
public void setSupportsNameFiltering(boolean supportsNameFiltering)
```
  - getKeyField
```
public String getKeyField()
```
    Description copied from interface: MasterDataModel
    
    Returns the key field name that references the master data instance
    
    Specified by:
    
    getKeyField in interface MasterDataModel
  - setKeyField
```
public void setKeyField(String keyField)
```
  - getIdField
```
public String getIdField()
```
    Description copied from interface: MasterDataModel
    
    Returns the id field name that uniquely identifies the master data instance
    
    Specified by:
    
    getIdField in interface MasterDataModel
  - setIdField
```
public void setIdField(String idField)
```
  - getNameField
```
public String getNameField()
```
    Description copied from interface: MasterDataModel
    
    Returns the name field name that can be used as a label for the master data instance
    
    Specified by:
    
    getNameField in interface MasterDataModel
  - setNameField
```
public void setNameField(String nameField)
```
  - getVariables
```
public Map<String,String> getVariables()
```
    Description copied from interface: MasterDataModel
    
    Returns the field name of each additional variable for the master data instance
    
    Specified by:
    
    getVariables in interface MasterDataModel
  - setVariables
```
public void setVariables(Map<String,String> variables)
```

Class DefaultMasterDataModel

Field Summary

Fields inherited from class com.flowable.dataobject.api.repository.BaseDataObjectModel

Constructor Summary

Method Summary

Methods inherited from class com.flowable.dataobject.api.repository.BaseDataObjectModel

Methods inherited from class java.lang.Object

Methods inherited from interface com.flowable.dataobject.api.repository.DataObjectModel

Field Detail

masterDataSourceId

managementCapabilities

filterParameters

defaultLocale

supportsNameFiltering

keyField

idField

nameField

variables

Constructor Detail

DefaultMasterDataModel

Method Detail

getMasterDataSourceId

setMasterDataSourceId

getManagementCapabilities

setManagementCapabilities

getFilterParameters

setFilterParameters

getDefaultLocale

setDefaultLocale

isSupportsNameFiltering

setSupportsNameFiltering

getKeyField

setKeyField

getIdField

setIdField

getNameField

setNameField

getVariables

setVariables