public interface DataObjectRuntimeService
DataObjectDefinition
s as well as some more data object and its
definition based features.
If you need strongly type support for builder and data objects then use the DataObjectDataSource
for that applicable data object.Modifier and Type | Method and Description |
---|---|
DataObjectInstanceBuilder<?,DataObjectInstance> |
createDataObjectInstanceBuilderByDefinitionId(String dataObjectDefinitionId)
Creates a new generic data object instance builder to create new data objects.
|
DataObjectInstanceBuilder<?,DataObjectInstance> |
createDataObjectInstanceBuilderByDefinitionKey(String dataObjectDefinitionKey)
Creates a new generic data object instance builder to create new data objects.
|
DataObjectInstanceBuilder<?,DataObjectInstance> |
createDataObjectInstanceBuilderByDefinitionKeyAndTenantId(String dataObjectDefinitionKey,
String tenantId)
Creates a new generic data object instance builder to create new data objects.
|
DataObjectInstanceQuery<?,DataObjectInstance> |
createDataObjectInstanceQueryByDefinitionId(String dataObjectDefinitionId)
Creates a new data object instance query object used to define a query returning data object instances.
|
DataObjectInstanceQuery<?,DataObjectInstance> |
createDataObjectInstanceQueryByDefinitionKey(String dataObjectDefinitionKey)
Creates a new data object instance query object used to define a query returning data object instances.
|
DataObjectModificationBuilder<?,DataObjectInstance> |
createDataObjectModificationBuilder(String lookupId,
String dataObjectDefinitionId)
Creates a new generic data object modification builder to modify existing data objects.
|
MasterDataInstanceBuilder |
createMasterDataInstanceBuilder()
Creates a builder to add a new master data instance
|
MasterDataInstanceQuery |
createMasterDataInstanceQuery()
Returns a master data instance query to be used when searching for master data instances.
|
void |
deleteDataObject(String lookupId,
String dataObjectDefinitionId)
Deletes the specified data object given by its lookup id and data object definition.
|
void |
deleteDataObjectVariablesByInstanceId(String dataInstanceId)
Deletes data object variables by master instance id
|
void |
deleteMasterDataInstancesByDefinitionId(String dataObjectDefinitionId)
Deletes master data instances by data object definition id
|
DataObjectInstance |
findDataObjectByLookupIdAndDefinitionId(String lookupId,
String dataObjectDefinitionId)
Lookup a single data object given by its lookup id and definition id.
|
DataObjectInstance |
findDataObjectByLookupIdAndDefinitionKey(String lookupId,
String dataObjectDefinitionKey)
Lookup a single data object given by its lookup id and definition key.
|
DataObjectDataSource<?,?,?,?> |
getDataSource(String dataSourceId)
Returns the data source given its id.
|
DataObjectDataSource<?,?,?,?> |
getDataSourceByDataObjectDefinitionId(String dataObjectDefinitionId)
Returns the data source handling the specified data object definition given by its id.
|
DataObjectDataSource<?,?,?,?> |
getDataSourceByDataObjectDefinitionKey(String dataObjectDefinitionKey)
Returns the data source handling the specified data object definition given by its key.
|
Map<String,Object> |
getMasterDataInstanceVariables(String masterDataInstanceId)
Get the variables for the master data instance with the provided id
|
void |
loadMasterDataInstanceData(String data,
String dataObjectDefinitionId)
Loads master data instance data into the data object engine
|
MasterDataInstance |
saveMasterDataInstance(MasterDataInstance masterDataInstance)
Saves an updated master data instance
|
DataObjectDataSource<?,?,?,?> getDataSource(String dataSourceId)
dataSourceId
- the id of the data source to be returnedorg.flowable.common.engine.api.FlowableIllegalArgumentException
- if such a data source does not existDataObjectDataSource<?,?,?,?> getDataSourceByDataObjectDefinitionKey(String dataObjectDefinitionKey)
dataObjectDefinitionKey
- the key of the data object definition to lookup its data sourceorg.flowable.common.engine.api.FlowableIllegalArgumentException
- if either the data object definition is not found or its data sourceDataObjectDataSource<?,?,?,?> getDataSourceByDataObjectDefinitionId(String dataObjectDefinitionId)
dataObjectDefinitionId
- the id of the data object definition to lookup its data sourceorg.flowable.common.engine.api.FlowableIllegalArgumentException
- if either the data object definition is not found or its data sourceDataObjectInstance findDataObjectByLookupIdAndDefinitionKey(String lookupId, String dataObjectDefinitionKey)
lookupId
- the lookup id of the data object to be returneddataObjectDefinitionKey
- the key of the data object definition to return a data object instance forDataObjectInstance findDataObjectByLookupIdAndDefinitionId(String lookupId, String dataObjectDefinitionId)
lookupId
- the lookup id of the data object to be returneddataObjectDefinitionId
- the id of the data object definition to return a data object instance forDataObjectInstanceQuery<?,DataObjectInstance> createDataObjectInstanceQueryByDefinitionKey(String dataObjectDefinitionKey)
dataObjectDefinitionKey
- the key of the data object definition to determine the data source to create a new query objectDataObjectInstanceQuery<?,DataObjectInstance> createDataObjectInstanceQueryByDefinitionId(String dataObjectDefinitionId)
dataObjectDefinitionId
- the id of the data object definition to determine the data source to create a new query objectDataObjectInstanceBuilder<?,DataObjectInstance> createDataObjectInstanceBuilderByDefinitionKey(String dataObjectDefinitionKey)
dataObjectDefinitionKey
- the key of the data object definition a new instance should be created forDataObjectInstanceBuilder<?,DataObjectInstance> createDataObjectInstanceBuilderByDefinitionKeyAndTenantId(String dataObjectDefinitionKey, String tenantId)
dataObjectDefinitionKey
- the key of the data object definition a new instance should be created fortenantId
- the tenant of the data object definitionDataObjectInstanceBuilder<?,DataObjectInstance> createDataObjectInstanceBuilderByDefinitionId(String dataObjectDefinitionId)
dataObjectDefinitionId
- the id of the data object definition a new instance should be created forDataObjectModificationBuilder<?,DataObjectInstance> createDataObjectModificationBuilder(String lookupId, String dataObjectDefinitionId)
lookupId
- the lookup id of the data object to be modifieddataObjectDefinitionId
- the id of the data object definition for the data object to be modifiedvoid deleteDataObject(String lookupId, String dataObjectDefinitionId)
lookupId
- the lookup id of the data object to be deleteddataObjectDefinitionId
- the id of the data object definition the data object is specified withvoid loadMasterDataInstanceData(String data, String dataObjectDefinitionId)
MasterDataInstanceQuery createMasterDataInstanceQuery()
MasterDataInstanceBuilder createMasterDataInstanceBuilder()
Map<String,Object> getMasterDataInstanceVariables(String masterDataInstanceId)
MasterDataInstance saveMasterDataInstance(MasterDataInstance masterDataInstance)
void deleteMasterDataInstancesByDefinitionId(String dataObjectDefinitionId)
void deleteDataObjectVariablesByInstanceId(String dataInstanceId)
Copyright © 2019. All rights reserved.