com.flowable.dataobject.api.runtime

Interface MasterDataSource

public interface MasterDataSource

A master data source is used to fetch master data entries for one or more DataObjectDefinitions.

Author:

Micha Kiener

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns the optional description for this master data source.
String	getId() Returns the id of this source which must be unique within the system, so there must only be exactly one master data source with that ID.
List<MasterDataInstance>	getMasterDataInstances(MasterDataInstanceQuery query) Returns a list of master data instances according the given query object used for filtering.
String	getName() Returns the name of the source for this master data.
SynchronizeResult	synchronizeMasterDataEntries(String masterDataDefinitionKey, boolean forceUpdate) Synchronizes the master data entries for the given master data definition.

Method Detail

getId

String getId()

Returns the id of this source which must be unique within the system, so there must only be exactly one master data source with that ID.

Returns:

the id of this master data source

getName

String getName()

Returns the name of the source for this master data.

Returns:

the name of this source

getDescription

String getDescription()

Returns the optional description for this master data source.

Returns:

the description of this source

getMasterDataInstances

List<MasterDataInstance> getMasterDataInstances(MasterDataInstanceQuery query)

Returns a list of master data instances according the given query object used for filtering.

Parameters:

query - the query to be used for entry filtering

Returns:

the list of master data instances matching the query, might be empty, but never null

synchronizeMasterDataEntries

SynchronizeResult synchronizeMasterDataEntries(String masterDataDefinitionKey,
                                               boolean forceUpdate)

Synchronizes the master data entries for the given master data definition. This is an optional method and depends on the source implementation.

Parameters:

masterDataDefinitionKey - the master data definition key the entry data should be synchronized

forceUpdate - true, if the synchronization should be done regardless of the currently saved objects

Returns:

an optional information message about the synchronization result