Package com.flowable.dataobject.api.runtime

Interface MasterDataInstanceUpdateBuilder

All Known Implementing Classes:

MasterDataInstanceUpdateBuilderImpl

public interface MasterDataInstanceUpdateBuilder

Helper for updating a Master data instance.

An instance can be obtained through the DataObjectRuntimeService.

masterDataInstanceId should be set before calling update() to update a master data instance.

Author:

Christopher Welsch

Method Summary

Modifier and Type	Method	Description
MasterDataInstanceUpdateBuilder	description(String name)	Set the description of the master data instance
MasterDataInstanceUpdateBuilder	externalId(String externalId)	Set the external id of the master data instance
MasterDataInstanceUpdateBuilder	favorite(boolean favorite)	Set the favorite value to true or false for the master data instance
MasterDataInstanceUpdateBuilder	key(String key)	Set the key of the master data instance
MasterDataInstanceUpdateBuilder	name(String name)	Set the name of the master data instance
MasterDataInstanceUpdateBuilder	sortOrder(int sortOrder)	Set the sort order of the master data instance
MasterDataInstanceUpdateBuilder	state(String state)	Set the state of the master data instance
MasterDataInstance	update()	Updates the master data instance

Method Details

key

MasterDataInstanceUpdateBuilder key(String key)

Set the key of the master data instance

externalId

MasterDataInstanceUpdateBuilder externalId(String externalId)

Set the external id of the master data instance

name

MasterDataInstanceUpdateBuilder name(String name)

Set the name of the master data instance

description

MasterDataInstanceUpdateBuilder description(String name)

Set the description of the master data instance

state

MasterDataInstanceUpdateBuilder state(String state)

Set the state of the master data instance

sortOrder

MasterDataInstanceUpdateBuilder sortOrder(int sortOrder)

Set the sort order of the master data instance

favorite

MasterDataInstanceUpdateBuilder favorite(boolean favorite)

Set the favorite value to true or false for the master data instance

update

MasterDataInstance update()

Updates the master data instance

Throws:

FlowableIllegalArgumentException - if masterDataInstanceId is null

FlowableObjectNotFoundException - when no master data instance with the given masterDataInstanceId exists