com.appiancorp.suiteapi.process

Class Instances

java.lang.Object

com.appiancorp.suiteapi.process.Instances

All Implemented Interfaces:

XMLable, java.io.Serializable

public class Instances
extends java.lang.Object
implements XMLable, java.io.Serializable

Class defines how many instances of the node will be created. The number to be spawned can be specified as a constant, value of process variable, length of an Array type process variable, number of assignee in the assignment pool or by an expression.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SPAWN_COUNT_ASSIGNEE_COUNT Number of spawned instances should be equal to the number of possible assignees in the assignment pool.
static int	SPAWN_COUNT_CONSTANT Number of spawned instances is specified using a constant.
static int	SPAWN_COUNT_EXPRESSION Number of spawned instances is specified using an expression.
static int	SPAWN_COUNT_PV_LENGTH Number of spawned instances is specified as number of values in a Process Variable of type multiple elements (eg Array, Vector).
static int	SPAWN_COUNT_PV_VALUE Number of spawned instances is specified using a process variable, whose value evaluates to a number

Fields inherited from interface com.appiancorp.suiteapi.common.XMLable

DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
Instances()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getExpression()
java.lang.Integer	getInstanceType()
boolean	getNextSpawnNew() Returns whether multiple instances of nodes should be created.
void	setExpression(java.lang.String expression_) Sets the expression about how to spawn multiple instances of node.
void	setInstanceType(java.lang.Integer instanceType_) Sets how the number of instances is specified.
void	setNextSpawnNew(boolean nextSpawnType_) Sets Whether many instances of nodes should be created
java.lang.String	toXML() Generates an XML representation of this object (including all child objects).
void	toXML(java.lang.StringBuilder buffer_) Appends the XML representation of the Instances to the given buffer.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.appiancorp.suiteapi.common.XMLable

toXML

Field Detail

SPAWN_COUNT_CONSTANT

public static final int SPAWN_COUNT_CONSTANT

Number of spawned instances is specified using a constant.

See Also:

Constant Field Values

SPAWN_COUNT_PV_VALUE

public static final int SPAWN_COUNT_PV_VALUE

Number of spawned instances is specified using a process variable, whose value evaluates to a number

See Also:

Constant Field Values

SPAWN_COUNT_PV_LENGTH

public static final int SPAWN_COUNT_PV_LENGTH

Number of spawned instances is specified as number of values in a Process Variable of type multiple elements (eg Array, Vector).

See Also:

Constant Field Values

SPAWN_COUNT_ASSIGNEE_COUNT

public static final int SPAWN_COUNT_ASSIGNEE_COUNT

Number of spawned instances should be equal to the number of possible assignees in the assignment pool.

See Also:

Constant Field Values

SPAWN_COUNT_EXPRESSION

public static final int SPAWN_COUNT_EXPRESSION

Number of spawned instances is specified using an expression.

See Also:

Constant Field Values

Constructor Detail

Instances

public Instances()

Method Detail

getExpression

public java.lang.String getExpression()

Returns:

the expression that specifies the how the instances of nodes are to be spawned

setExpression

public void setExpression(java.lang.String expression_)

Sets the expression about how to spawn multiple instances of node.

getInstanceType

public java.lang.Integer getInstanceType()

Returns:

how the instances of node are to be spawned. It is one of the SPAWN_COUNT_XXX Constants.

setInstanceType

public void setInstanceType(java.lang.Integer instanceType_)

Sets how the number of instances is specified.

See Also:

SPAWN_COUNT_CONSTANT, SPAWN_COUNT_PV_VALUE, SPAWN_COUNT_PV_LENGTH, SPAWN_COUNT_ASSIGNEE_COUNT, SPAWN_COUNT_EXPRESSION

toXML

public java.lang.String toXML()

Description copied from interface: XMLable

Generates an XML representation of this object (including all child objects). A typical implementation is to create a new StringBuilder and call toXML( StringBuilder ) on it.

Specified by:

toXML in interface XMLable

Returns:

converts this Instances to XML and returns it as a String

toXML

public void toXML(java.lang.StringBuilder buffer_)

Appends the XML representation of the Instances to the given buffer.

Specified by:

toXML in interface XMLable

Parameters:

buffer_ - The buffer on which to append the XML representation.

getNextSpawnNew

public boolean getNextSpawnNew()

Returns whether multiple instances of nodes should be created.

Returns:

true if multiple instances are to be created, false otherwise.

setNextSpawnNew

public void setNextSpawnNew(boolean nextSpawnType_)

Sets Whether many instances of nodes should be created

Parameters:

nextSpawnType_ - true if many instances of nodes are to spwaned, false otherwise.