org.bonitasoft.engine.operation

Class LeftOperandBuilder

java.lang.Object

org.bonitasoft.engine.operation.LeftOperandBuilder

public class LeftOperandBuilder
extends Object

Builder for LeftOperand. LeftOperand is part of the Operation framework. A LeftOperand have a name, which is a reference to a data / variable, or a document. The value of the reference is evaluated at runtime, according to the Operation context.

Author:

Zhang Bole, Emmanuel Duchastenier, Baptiste Mesta

See Also:

Operation, OperationBuilder

Constructor Summary

Constructors

Constructor and Description
LeftOperandBuilder()

Method Summary

Modifier and Type	Method and Description
LeftOperand	createBusinessDataLeftOperand(String dataName) creates a LeftOperand object to set a data, with a default value of external to false (data will be updated in Bonita system)
LeftOperand	createDataLeftOperand(String dataName) creates a LeftOperand object to set a data, with a default value of external to false (data will be updated in Bonita system)
LeftOperand	createDataLeftOperand(String dataName, boolean external) Deprecated. use createDataLeftOperand(String)
LeftOperandBuilder	createNewInstance() Initiate the building of a new LeftOperand.
LeftOperandBuilder	createNewInstance(String name)
LeftOperand	createSearchIndexLeftOperand(int index)
LeftOperand	done()
LeftOperandBuilder	setExternal(boolean external) Deprecated. use setType(LeftOperand.TYPE_EXTERNAL_DATA) instead
LeftOperandBuilder	setName(String name) Sets the name of this LeftOperand.
LeftOperandBuilder	setType(LeftOperandType type) Deprecated. use setType(String)
LeftOperandBuilder	setType(String type) Set the type of the left operand It can be LeftOperand.TYPE_DATA LeftOperand.TYPE_BUSINESS_DATA LeftOperand.TYPE_DOCUMENT LeftOperand.TYPE_EXTERNAL_DATA LeftOperand.TYPE_SEARCH_INDEX LeftOperand.TYPE_TRANSIENT_DATA or an other type of org.bonitasoft.engine.core.operation.LeftOperandHandler registered in the configuration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LeftOperandBuilder

public LeftOperandBuilder()

Method Detail

createNewInstance

public LeftOperandBuilder createNewInstance()

Initiate the building of a new LeftOperand. The LeftOperand building will be complete when calling the done() method.

Returns:

this builder itself, so that calls the various exposed methods can be chained.

createNewInstance

public LeftOperandBuilder createNewInstance(String name)

setName

public LeftOperandBuilder setName(String name)

Sets the name of this LeftOperand. Can be a reference to a data / variable, or to a document.

Parameters:

name - the name of the reference that will be set by this operation execution

Returns:

this builder itself, so that calls the various exposed methods can be chained.

setType

public LeftOperandBuilder setType(String type)

Set the type of the left operand It can be LeftOperand.TYPE_DATA LeftOperand.TYPE_BUSINESS_DATA LeftOperand.TYPE_DOCUMENT LeftOperand.TYPE_EXTERNAL_DATA LeftOperand.TYPE_SEARCH_INDEX LeftOperand.TYPE_TRANSIENT_DATA or an other type of org.bonitasoft.engine.core.operation.LeftOperandHandler registered in the configuration

Parameters:

type -

Returns:

setType

@Deprecated
public LeftOperandBuilder setType(LeftOperandType type)

Deprecated. use setType(String)

Parameters:

type -

Returns:

setExternal

@Deprecated
public LeftOperandBuilder setExternal(boolean external)

Deprecated. use setType(LeftOperand.TYPE_EXTERNAL_DATA) instead

Parameters:

external -

Returns:

this builder itself, so that calls the various exposed methods can be chained.

done

public LeftOperand done()

createSearchIndexLeftOperand

public LeftOperand createSearchIndexLeftOperand(int index)

createDataLeftOperand

@Deprecated
public LeftOperand createDataLeftOperand(String dataName,
                                                     boolean external)

Deprecated. use createDataLeftOperand(String)

Parameters:

dataName -

external -

Returns:

createDataLeftOperand

public LeftOperand createDataLeftOperand(String dataName)

creates a LeftOperand object to set a data, with a default value of external to false (data will be updated in Bonita system)

Parameters:

dataName - the name of the data to set

Returns:

the newly created LeftOperand object

createBusinessDataLeftOperand

public LeftOperand createBusinessDataLeftOperand(String dataName)

creates a LeftOperand object to set a data, with a default value of external to false (data will be updated in Bonita system)

Parameters:

dataName - the name of the data to set

Returns:

the newly created LeftOperand object