Package com.flowable.dataobject.api.runtime

Interface MasterDataInstanceBuilder

All Known Implementing Classes:
MasterDataInstanceBuilderImpl
public interface MasterDataInstanceBuilder
Helper for creating a new Master data instance. An instance can be obtained through the DataObjectRuntimeService. dataObjectDefinitionId or dataObjectDefinitionKey should be set before calling create() to create a master data instance.
Author:
Tijs Rademakers

  • Method Details

    • dataObjectDefinitionId

      MasterDataInstanceBuilder dataObjectDefinitionId(String dataObjectDefinitionId)
      Set the id of the master data object definition

    • dataObjectDefinitionKey

      MasterDataInstanceBuilder dataObjectDefinitionKey(String dataObjectDefinitionKey)
      Set the key of the master data object definition, latest version of the data object definition with the given key. If dataObjectDefinitionId was set this will be ignored

    • key

      MasterDataInstanceBuilder key(String key)
      Set the key of the master data instance

    • externalId

      MasterDataInstanceBuilder externalId(String externalId)
      Set the external id of the master data instance

    • name

      MasterDataInstanceBuilder name(String name)
      Set the name of the master data instance

    • description

      MasterDataInstanceBuilder description(String name)
      Set the description of the master data instance

    • state

      MasterDataInstanceBuilder state(String state)
      Set the state of the master data instance

    • sortOrder

      MasterDataInstanceBuilder sortOrder(int sortOrder)
      Set the sort order of the master data instance

    • favorite

      MasterDataInstanceBuilder favorite()
      Set the favorite value to true for the master data instance

    • creatorId

      MasterDataInstanceBuilder creatorId(String creatorId)
      Set the creator id of the master data instance

    • updaterId

      MasterDataInstanceBuilder updaterId(String updaterId)
      Set the updater id of the master data instance

    • tenantId

      MasterDataInstanceBuilder tenantId(String tenantId)
      Set the tenant id to resolve the data object definition

    • overrideDataObjectDefinitionId

      MasterDataInstanceBuilder overrideDataObjectDefinitionId(String tenantId)
      Indicator to override the tenant id of the data object definition with the provided value. The tenantId to lookup the data object definition should still be provided if needed.

    • addVariableValue

      MasterDataInstanceBuilder addVariableValue(String name, Object value)
      add a variable with name and value

    • create

      MasterDataInstance create()
      creates the master data instance
      Throws:
      org.flowable.common.engine.api.FlowableIllegalArgumentException - if dataObjectDefinitionKey and dataObjectDefinitionId are null
      org.flowable.common.engine.api.FlowableObjectNotFoundException - when no data object definition is deployed with the given dataObjectDefinitionKey or dataObjectDefinitionId