com.appiancorp.suiteapi.process

Class ActivityClass

java.lang.Object

com.appiancorp.suiteapi.common.Identity

com.appiancorp.suiteapi.process.ActivityClass

All Implemented Interfaces:

JSONable, JSONCacheable, LocalId, XMLable, AppianTypeHolder, java.io.Serializable

public class ActivityClass
extends Identity
implements JSONCacheable, XMLable, AppianTypeHolder

The activity that is run when a ProcessNode is traversed. This representation is mainly used at design time, though.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Long	OUTPUT_EXPRESSION_TYPE_CUSTOM
static java.lang.Long	OUTPUT_EXPRESSION_TYPE_RESULT
static java.lang.Long	OUTPUT_EXPRESSION_TYPE_SAVE_INTO
static int	UA_CAN_BE_ATTENDED
static int	UA_CAN_BE_BOTH
static int	UA_CAN_BE_UNATTENDED

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

hiddenAttributes$TRANSIENT

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

DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
ActivityClass()
ActivityClass(ActivityClassSchema schema_)

Method Summary

Modifier and Type	Method and Description
void	fillInAppianTypes(AppianTypeCache cache_) If the implementing class references any Appian-typed objects (such as User, Group, Folder), this method should be implemented to put the primary keys of these objects in the given cache.
java.lang.Long	getAcSchemaId() Gets the Activity Class Schema ID of this activity class
ActivityClassParameter[]	getCustomParameters() Gets the list of parameters that have been added at design time, and need to be available at runtime.
FormConfig	getFormConfig(java.util.Locale locale_) Gets the form config corresponding to the given locale, or null if no such config exists.
FormConfigMap	getFormConfigMap() Gets the information about the form associated with this activity class.
java.lang.String	getHelperClass() Gets the helper class for this activity class.
java.util.HashSet	getHiddenAttributes() Returns the set of attributes (properties) that should not be included in the JSON representation of the object.
java.lang.String	getLocalId() Gets the Activity Class Local ID of this activity class
java.lang.String[]	getOutputExpressions() Gets the expressions that are evaluated at the end of the activity.
java.lang.Long[]	getOutputExpressionsFlags() Gets the expression flags for the output expressions.
ActivityClassParameter[]	getParameters() Gets the list of parameters of the activity class.
java.lang.Long	getRunAs() Gets the role (such as process initiator) that this task should ran as if it is unassigned.
java.lang.Long	getUnattended() Indicates whether the activity class requires user interaction to complete
void	setAcSchemaId(java.lang.Long acSchemaId_) Sets the Activity Class Schema ID of this activity class
void	setCustomParameters(ActivityClassParameter[] customParameters_) Sets the list of parameters that have been added at design time, and need to be available at runtime.
void	setFormConfigMap(FormConfigMap formConfigMap_) Sets the information about the form associated with this activity class
void	setHelperClass(java.lang.String helperClass_) Sets the helper class for this activity class.
void	setLocalId(java.lang.String localId_) Sets the Activity Class Local ID of this activity class
void	setOutputExpressions(java.lang.String[] outputExpressions_) Sets the expressions that are evaluated at the end of the activity.
void	setOutputExpressionsFlags(java.lang.Long[] outputExpressionsFlags_) Sets the expression flags These define what type of output expression each value of the outputExpression array contains.
void	setParameters(ActivityClassParameter[] parameters_) Gets the list of parameters of the activity class.
void	setRunAs(java.lang.Long runAs_) Sets the role (such as process initiator) that this task should ran as if it is unassigned.
void	setUnattended(java.lang.Long unattended_) Sets whether the activity class requires user interaction to complete
java.lang.String	toString() Returns a string representation of the Identity.
java.lang.String	toXML() Generates an XML representation of this object (including all child objects).
void	toXML(java.lang.StringBuffer buffer_) Appends an XML representation of this object (including all child objects) to the given buffer.
void	toXML(java.lang.StringBuilder buffer_) Appends an XML representation of this object (including all child objects) to the given buffer.

Methods inherited from class com.appiancorp.suiteapi.common.Identity

equals, getId, getName, getUuid, hashCode, setId, setName, setUuid

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

UA_CAN_BE_ATTENDED

public static final int UA_CAN_BE_ATTENDED

See Also:

Constant Field Values

UA_CAN_BE_UNATTENDED

public static final int UA_CAN_BE_UNATTENDED

See Also:

Constant Field Values

UA_CAN_BE_BOTH

public static final int UA_CAN_BE_BOTH

See Also:

Constant Field Values

OUTPUT_EXPRESSION_TYPE_CUSTOM

public static final java.lang.Long OUTPUT_EXPRESSION_TYPE_CUSTOM

OUTPUT_EXPRESSION_TYPE_RESULT

public static final java.lang.Long OUTPUT_EXPRESSION_TYPE_RESULT

OUTPUT_EXPRESSION_TYPE_SAVE_INTO

public static final java.lang.Long OUTPUT_EXPRESSION_TYPE_SAVE_INTO

Constructor Detail

ActivityClass

public ActivityClass()

ActivityClass

public ActivityClass(ActivityClassSchema schema_)

Method Detail

getHiddenAttributes

public java.util.HashSet getHiddenAttributes()

Description copied from interface: JSONable

Returns the set of attributes (properties) that should not be included in the JSON representation of the object.

Specified by:

getHiddenAttributes in interface JSONable

Returns:

the set of hidden attributes

getParameters

public ActivityClassParameter[] getParameters()

Gets the list of parameters of the activity class.

Returns:

an array of ActivityClassParameter objects representing the activity class parameters for this activity class.

See Also:

ActivityClassParameter

setParameters

public void setParameters(ActivityClassParameter[] parameters_)

Gets the list of parameters of the activity class.

Parameters:

parameters_ - an array of ActivityClassParameter objects representing the activity class parameters to set for this activity class.

See Also:

ActivityClassParameter

getUnattended

public java.lang.Long getUnattended()

Indicates whether the activity class requires user interaction to complete

Returns:

UA_CAN_BE_ATTENDED if the activity class is attended (requires human interaction), UA_CAN_BE_UNATTENDED if the activity class is unattended.

setUnattended

public void setUnattended(java.lang.Long unattended_)

Sets whether the activity class requires user interaction to complete

Parameters:

unattended_ - unattended value of the activity class. Allowed values are : UA_CAN_BE_ATTENDED if the activity class is attended (requires human interaction), UA_CAN_BE_UNATTENDED if the activity class is unattended.

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:

The XML representation of this object.

toXML

public void toXML(java.lang.StringBuffer buffer_)

Description copied from interface: XMLable

Appends an XML representation of this object (including all child objects) to the given buffer. Override for performance.

Specified by:

toXML in interface XMLable

Parameters:

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

toXML

public void toXML(java.lang.StringBuilder buffer_)

Description copied from interface: XMLable

Appends an XML representation of this object (including all child objects) to the given buffer. Override for performance.

Specified by:

toXML in interface XMLable

Parameters:

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

toString

public java.lang.String toString()

Description copied from class: Identity

Returns a string representation of the Identity. In general, the toString method returns a string that "textually represents" this object.

Overrides:

toString in class Identity

Returns:

String representation of the object

getAcSchemaId

public java.lang.Long getAcSchemaId()

Gets the Activity Class Schema ID of this activity class

Returns:

the Activity Class Schema ID of this activity class

setAcSchemaId

public void setAcSchemaId(java.lang.Long acSchemaId_)

Sets the Activity Class Schema ID of this activity class

Parameters:

acSchemaId_ - the Activity Class Schema ID of this activity class to set

fillInAppianTypes

public void fillInAppianTypes(AppianTypeCache cache_)

Description copied from interface: AppianTypeHolder

If the implementing class references any Appian-typed objects (such as User, Group, Folder), this method should be implemented to put the primary keys of these objects in the given cache. Later, the cache will populate itself with the display strings that correspond to all of its ids, such as "Human Resources" for group 9.

Specified by:

fillInAppianTypes in interface AppianTypeHolder

Parameters:

cache_ - cache of Appian-typed objects.

getRunAs

public java.lang.Long getRunAs()

Gets the role (such as process initiator) that this task should ran as if it is unassigned. At runtime, a lookup will be performed to resolve the assignee as a User. (0 = process initiator, 1 = process model designer)

Returns:

a Long indicating the role to set (0 = process initiator, 1 = process model designer)

setRunAs

public void setRunAs(java.lang.Long runAs_)

Sets the role (such as process initiator) that this task should ran as if it is unassigned. At runtime, a lookup will be performed to resolve the assignee as a User.

Parameters:

runAs_ - a Long indicating the role to set (0 = process initiator, 1 = process model designer)

getCustomParameters

public ActivityClassParameter[] getCustomParameters()

Gets the list of parameters that have been added at design time, and need to be available at runtime.

Returns:

an array of ActivityClassParameter objects representing the activity class parameters for this activity class.

See Also:

ActivityClassParameter

setCustomParameters

public void setCustomParameters(ActivityClassParameter[] customParameters_)

Sets the list of parameters that have been added at design time, and need to be available at runtime.

Parameters:

customParameters_ - an array of ActivityClassParameter objects representing the activity class parameters to set for this activity class.

See Also:

ActivityClassParameter

getOutputExpressions

public java.lang.String[] getOutputExpressions()

Gets the expressions that are evaluated at the end of the activity. These expressions can be used to save the values of ACPs and ARVs into PVs. You should also set the outputExpressionsFlags to differentiate from custom output expressions, ARV output expressions, etc.

Returns:

an array containing the evaluated expressions

setOutputExpressions

public void setOutputExpressions(java.lang.String[] outputExpressions_)

Sets the expressions that are evaluated at the end of the activity. These expressions can be used to save the values of ACPs and ARVs into PVs.

Parameters:

outputExpressions_ - an array containing the evaluated expressions to set

getOutputExpressionsFlags

public java.lang.Long[] getOutputExpressionsFlags()

Gets the expression flags for the output expressions. The output expression types can be one of OUTPUT_EXPRESSION_TYPE_CUSTOM, OUTPUT_EXPRESSION_TYPE_RESULT or OUTPUT_EXPRESSION_TYPE_SAVE_INTO

Returns:

the array containing the type of output expressions

setOutputExpressionsFlags

public void setOutputExpressionsFlags(java.lang.Long[] outputExpressionsFlags_)

Sets the expression flags These define what type of output expression each value of the outputExpression array contains. It should be the same length as the outputExpressions array. The output expression types can be one of OUTPUT_EXPRESSION_TYPE_CUSTOM, OUTPUT_EXPRESSION_TYPE_RESULT or OUTPUT_EXPRESSION_TYPE_SAVE_INTO

Parameters:

outputExpressionsFlags_ - the array of output expression flags set

getFormConfigMap

public FormConfigMap getFormConfigMap()

Gets the information about the form associated with this activity class.

Returns:

a FormConfig object that represents information about the form associated with this activity class

See Also:

FormConfig

getFormConfig

public FormConfig getFormConfig(java.util.Locale locale_)

Gets the form config corresponding to the given locale, or null if no such config exists.

Parameters:

locale_ -

Returns:

setFormConfigMap

public void setFormConfigMap(FormConfigMap formConfigMap_)

Sets the information about the form associated with this activity class

Parameters:

formConfig_ - a FormConfig object that represents information about the form associated with this activity class to set

getHelperClass

public java.lang.String getHelperClass()

Gets the helper class for this activity class. A parameter helper class is used by the framework to help execute an activity class. The parameter helper class is associated with an activity class in the activity class config xml file, and must implement the ActivityParameterHelper interface. The helper class is optional. Please refer to the ActivityParameterHelper class for more information on the specific functionality of a helper class.

Returns:

the helper class

setHelperClass

public void setHelperClass(java.lang.String helperClass_)

Sets the helper class for this activity class.

Parameters:

helperClass_ - the helper class

See Also:

getHelperClass()

getLocalId

public java.lang.String getLocalId()

Gets the Activity Class Local ID of this activity class

Returns:

the Activity Class Local ID of this activity class

setLocalId

public void setLocalId(java.lang.String localId_)

Sets the Activity Class Local ID of this activity class

Parameters:

localId__ - the Activity Class Local ID of this activity class to set