com.appiancorp.suiteapi.process.framework

Class SafeActivityReturnVariable

java.lang.Object

com.appiancorp.suiteapi.process.framework.SafeActivityReturnVariable

public class SafeActivityReturnVariable
extends java.lang.Object

Wrapper for ActivityReturnVariable that enforces non-null value, and contains only getters so that users cannot change the values.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	LOG

Constructor Summary

Constructors

Constructor and Description
SafeActivityReturnVariable(ActivityReturnVariable delegate_) Deprecated.
SafeActivityReturnVariable(ActivityReturnVariable delegate_, TypeService ts) Instantiates a wrapper for a ActivityReturnVariable object.

Method Summary

Modifier and Type	Method and Description
SafeActivityReturnVariable[]	children() If the type of the variable is BEAN, returns an array of ACP who are the fields of the bean.
static SafeActivityReturnVariable	findByName(SafeActivityReturnVariable[] variables_, java.lang.String name_) Finds the variable in the given array whose namecorresponds to the given name.
static ActivityReturnVariable[]	getArvs(SafeActivityReturnVariable[] safes_)
java.lang.Long	getInstanceType()
java.lang.String	getKey()
java.lang.String	getName()
java.lang.Long	getType() Deprecated. use getInstanceType()
java.lang.Object	getValue()
void	setValue(java.lang.Object value_) Sets the value of the typed variable.
java.lang.String	toString() converts typed variable to a string

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Logger LOG

Constructor Detail

SafeActivityReturnVariable

@Deprecated
public SafeActivityReturnVariable(ActivityReturnVariable delegate_)

Deprecated.

Use SafeActivityReturnVariable(ActivityReturnVariable, TypeService)

SafeActivityReturnVariable

public SafeActivityReturnVariable(ActivityReturnVariable delegate_,
                                  TypeService ts)

Instantiates a wrapper for a ActivityReturnVariable object.

Method Detail

toString

public java.lang.String toString()

converts typed variable to a string

Overrides:

toString in class java.lang.Object

Returns:

the string representation of the underlying typed variable

children

public SafeActivityReturnVariable[] children()

If the type of the variable is BEAN, returns an array of ACP who are the fields of the bean. If the type of the variable is BEAN_ARRAY, returns an array of the ACP who are the cells in the array. Otherwise, returns null. All non-null return values are wrapped in SafeActivityReturnVariables.

Note that this is not a getXXX method, so as not to be confused with a property (mostly by ASL/k).

getType

public java.lang.Long getType()

Deprecated. use getInstanceType()

Returns:

the type of the typed variable

getInstanceType

public java.lang.Long getInstanceType()

getKey

public java.lang.String getKey()

Returns:

the key(name) of the typed variable

getName

public java.lang.String getName()

getValue

public java.lang.Object getValue()

Returns:

the value of the typed variable

setValue

public void setValue(java.lang.Object value_)

Sets the value of the typed variable. Unlike the method on typed variable, this one will not do any conversions - the type must be exactly right.

Throws:

java.lang.IllegalStateException - If called on an object of type BEAN or BEAN_ARRAY

java.lang.IllegalArgumentException - If called with an object that is not of the correct type

findByName

public static SafeActivityReturnVariable findByName(SafeActivityReturnVariable[] variables_,
                                                    java.lang.String name_)

Finds the variable in the given array whose namecorresponds to the given name. If no such variable can be found, returns null.

Parameters:

variables_ - SafeActivityReturnVariables to search through

name_ - name of activity variable to search for

Returns:

the first SafeActivityReturnVariable that exactly matches name_

getArvs

public static ActivityReturnVariable[] getArvs(SafeActivityReturnVariable[] safes_)

Parameters:

safes_ - The SafeActivityReturnVariable objects to get ActivityReturnVariable objects for

Returns:

the ActivityReturnVariable objects relating to the given SafeActivityReturnVariable objects