Package com.flowable.dataobject.api.runtime

Interface DataObjectRuntimeService

  • All Known Implementing Classes:
    DataObjectRuntimeServiceImpl
    public interface DataObjectRuntimeService
    The data object runtime service supports lookup of data object instances based on DataObjectDefinitions 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.
    Author:
    Micha Kiener

    • Method Detail

      • getDataSource

        DataObjectDataSource getDataSource​(java.lang.String dataSourceId)
        Returns the data source given its id.
        Parameters:
        dataSourceId - the id of the data source to be returned
        Returns:
        the data source
        Throws:
        org.flowable.common.engine.api.FlowableIllegalArgumentException - if such a data source does not exist

      • findDataObjectValueByLookupIdAndDefinitionKey

        DataObjectInstanceVariableContainer findDataObjectValueByLookupIdAndDefinitionKey​(java.lang.String lookupId,
                                                                                  java.lang.String dataObjectDefinitionKey)
        Lookup a single data object given by its lookup id and definition key.
        Parameters:
        lookupId - the lookup id of the data object to be returned
        dataObjectDefinitionKey - the key of the data object definition to return a data object instance for
        Returns:
        the data object instance, if found, null otherwise

      • findDataObjectValueByLookupIdAndDefinitionKey

        DataObjectInstanceVariableContainer findDataObjectValueByLookupIdAndDefinitionKey​(java.lang.String lookupId,
                                                                                  java.lang.String dataObjectDefinitionKey,
                                                                                  java.lang.String tenantId)
        Lookup a single data object given by its lookup id and definition key.
        Parameters:
        lookupId - the lookup id of the data object to be returned
        dataObjectDefinitionKey - the key of the data object definition to return a data object instance for
        tenantId - the tenant id to return a data object instance for
        Returns:
        the data object instance, if found, null otherwise

      • findDataObjectValueByDataObjectInstanceId

        DataObjectInstanceVariableContainer findDataObjectValueByDataObjectInstanceId​(java.lang.String instanceId)
        Lookup a single data object given by its instance id.
        Parameters:
        instanceId - the instance id of the data object to be returned
        Returns:
        the data object instance, if found, null otherwise

      • findDataObjectValueByLookupIdAndDefinitionId

        DataObjectInstanceVariableContainer findDataObjectValueByLookupIdAndDefinitionId​(java.lang.String lookupId,
                                                                                 java.lang.String dataObjectDefinitionId)
        Lookup a single data object given by its lookup id and definition id.
        Parameters:
        lookupId - the lookup id of the data object to be returned
        dataObjectDefinitionId - the id of the data object definition to return a data object instance for
        Returns:
        the data object instance, if found, null otherwise

      • createDataObjectValueInstanceBuilderByDefinitionKey

        DataObjectInstanceVariableContainerBuilder createDataObjectValueInstanceBuilderByDefinitionKey​(java.lang.String dataObjectDefinitionKey)
        Creates a new generic data object instance builder to create new data objects.
        Parameters:
        dataObjectDefinitionKey - the key of the data object definition a new instance should be created for
        Returns:
        the data object instance builder

      • createDataObjectValueInstanceBuilderByDefinitionKeyAndTenantId

        DataObjectInstanceVariableContainerBuilder createDataObjectValueInstanceBuilderByDefinitionKeyAndTenantId​(java.lang.String dataObjectDefinitionKey,
                                                                                                          java.lang.String tenantId)
        Creates a new generic data object instance builder to create new data objects.
        Parameters:
        dataObjectDefinitionKey - the key of the data object definition a new instance should be created for
        tenantId - the tenant of the data object definition
        Returns:
        the data object instance builder

      • createDataObjectValueInstanceBuilderByDefinitionId

        DataObjectInstanceVariableContainerBuilder createDataObjectValueInstanceBuilderByDefinitionId​(java.lang.String dataObjectDefinitionId)
        Creates a new generic data object instance builder to create new data objects.
        Parameters:
        dataObjectDefinitionId - the id of the data object definition a new instance should be created for
        Returns:
        the data object instance builder

      • createDataObjectModificationBuilder

        DataObjectModificationBuilder createDataObjectModificationBuilder​(java.lang.String dataObjectDefinitionId)
        Creates a new database schema data object modification builder to modify existing data objects. As we already know the data object to be modified, this method will get a modification builder through the data source handling this specific data object.
        Parameters:
        dataObjectDefinitionId - the id of the data object definition for the data object to be modified
        Returns:
        the data object modification builder

      • deleteDataObject

        void deleteDataObject​(java.lang.String lookupId,
                      java.lang.String dataObjectDefinitionId)
        Deletes the specified data object given by its lookup id and data object definition.
        Parameters:
        lookupId - the lookup id of the data object to be deleted
        dataObjectDefinitionId - the id of the data object definition the data object is specified with

      • loadMasterDataInstanceData

        void loadMasterDataInstanceData​(java.lang.String data,
                                java.lang.String dataObjectDefinitionId)
        Loads master data instance data into the data object engine

      • createDataObjectInstanceQuery

        DataObjectInstanceQuery createDataObjectInstanceQuery()
        Returns a data object instance query to be used when searching for data object instances.
        Returns:
        the query instance used to specify the data object instance query terms

      • createMasterDataInstanceQuery

        MasterDataInstanceQuery createMasterDataInstanceQuery()
        Returns a master data instance query to be used when searching for master data instances.
        Returns:
        the query instance used to specify the master data instance query terms

      • createMasterDataInstanceBuilder

        MasterDataInstanceBuilder createMasterDataInstanceBuilder()
        Creates a builder to add a new master data instance
        Returns:
        the master data instance builder

      • createMasterDataInstanceImportBuilder

        MasterDataInstanceImportBuilder createMasterDataInstanceImportBuilder()
        Creates a loader to add a new master data instances from a document.
        Returns:
        the master data instance loader

      • getMasterDataInstanceVariables

        java.util.Map<java.lang.String,​java.lang.Object> getMasterDataInstanceVariables​(java.lang.String masterDataInstanceId)
        Get the variables for the master data instance with the provided id
        Returns:
        the master data instance variables

      • saveMasterDataInstance

        MasterDataInstance saveMasterDataInstance​(MasterDataInstance masterDataInstance)
        Saves an updated master data instance
        Returns:
        the updated master data instance

      • deleteMasterDataInstancesByDefinitionId

        void deleteMasterDataInstancesByDefinitionId​(java.lang.String dataObjectDefinitionId)
        Deletes master data instances by data object definition id

      • deleteDataObjectVariablesByInstanceId

        void deleteDataObjectVariablesByInstanceId​(java.lang.String dataInstanceId)
        Deletes data object variables by master instance id