Package 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
,Serializable
The activity that is run when a ProcessNode is traversed. This
representation is mainly used at design time, though.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Long
static final Long
static final Long
static final int
static final int
static final int
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
-
Method Summary
Modifier and TypeMethodDescriptionvoid
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.Gets the Activity Class Schema ID of this activity classGets the list of parameters that have been added at design time, and need to be available at runtime.getFormConfig
(Locale locale_) Gets the form config corresponding to the given locale, or null if no such config exists.Gets the information about the form associated with this activity class.Gets the helper class for this activity class.Returns the set of attributes (properties) that should not be included in the JSON representation of the object.Gets the Activity Class Local ID of this activity classString[]
Gets the expressions that are evaluated at the end of the activity.Long[]
Gets the expression flags for the output expressions.Gets the list of parameters of the activity class.getRunAs()
Gets the role (such as process initiator) that this task should ran as if it is unassigned.Indicates whether the activity class requires user interaction to completevoid
setAcSchemaId
(Long acSchemaId_) Sets the Activity Class Schema ID of this activity classvoid
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 classvoid
setHelperClass
(String helperClass_) Sets the helper class for this activity class.void
setLocalId
(String localId_) Sets the Activity Class Local ID of this activity classvoid
setOutputExpressions
(String[] outputExpressions_) Sets the expressions that are evaluated at the end of the activity.void
setOutputExpressionsFlags
(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
Sets the role (such as process initiator) that this task should ran as if it is unassigned.void
setUnattended
(Long unattended_) Sets whether the activity class requires user interaction to completetoString()
Returns a string representation of theIdentity
.toXML()
Generates an XML representation of this object (including all child objects).void
toXML
(StringBuffer buffer_) Appends an XML representation of this object (including all child objects) to the given buffer.void
toXML
(StringBuilder buffer_) Appends an XML representation of this object (including all child objects) to the given buffer.
-
Field Details
-
UA_CAN_BE_ATTENDED
public static final int UA_CAN_BE_ATTENDED- See Also:
-
UA_CAN_BE_UNATTENDED
public static final int UA_CAN_BE_UNATTENDED- See Also:
-
UA_CAN_BE_BOTH
public static final int UA_CAN_BE_BOTH- See Also:
-
OUTPUT_EXPRESSION_TYPE_CUSTOM
-
OUTPUT_EXPRESSION_TYPE_RESULT
-
OUTPUT_EXPRESSION_TYPE_SAVE_INTO
-
-
Constructor Details
-
ActivityClass
public ActivityClass() -
ActivityClass
-
-
Method Details
-
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 interfaceJSONable
- Returns:
- the set of hidden attributes
-
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:
-
setParameters
Gets the list of parameters of the activity class.- Parameters:
parameters_
- an array ofActivityClassParameter
objects representing the activity class parameters to set for this activity class.- See Also:
-
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
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
Description copied from interface:XMLable
Generates an XML representation of this object (including all child objects). A typical implementation is to create a newStringBuilder
and calltoXML( StringBuilder )
on it. -
toXML
Description copied from interface:XMLable
Appends an XML representation of this object (including all child objects) to the given buffer. Override for performance. -
toXML
Description copied from interface:XMLable
Appends an XML representation of this object (including all child objects) to the given buffer. Override for performance. -
toString
Description copied from class:Identity
Returns a string representation of theIdentity
. In general, the toString method returns a string that "textually represents" this object. -
getAcSchemaId
Gets the Activity Class Schema ID of this activity class- Returns:
- the Activity Class Schema ID of this activity class
-
setAcSchemaId
Sets the Activity Class Schema ID of this activity class- Parameters:
acSchemaId_
- the Activity Class Schema ID of this activity class to set
-
fillInAppianTypes
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 interfaceAppianTypeHolder
- Parameters:
cache_
- cache of Appian-typed objects.
-
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
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_
- aLong
indicating the role to set (0 = process initiator, 1 = process model designer)
-
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:
-
setCustomParameters
Sets the list of parameters that have been added at design time, and need to be available at runtime.- Parameters:
customParameters_
- an array ofActivityClassParameter
objects representing the activity class parameters to set for this activity class.- See Also:
-
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
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
Gets the expression flags for the output expressions. The output expression types can be one ofOUTPUT_EXPRESSION_TYPE_CUSTOM
,OUTPUT_EXPRESSION_TYPE_RESULT
orOUTPUT_EXPRESSION_TYPE_SAVE_INTO
- Returns:
- the array containing the type of output expressions
-
setOutputExpressionsFlags
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 ofOUTPUT_EXPRESSION_TYPE_CUSTOM
,OUTPUT_EXPRESSION_TYPE_RESULT
orOUTPUT_EXPRESSION_TYPE_SAVE_INTO
- Parameters:
outputExpressionsFlags_
- the array of output expression flags set
-
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:
-
getFormConfig
Gets the form config corresponding to the given locale, or null if no such config exists.- Parameters:
locale_
-- Returns:
-
setFormConfigMap
Sets the information about the form associated with this activity class- Parameters:
formConfigMap_
- aFormConfig
object that represents information about the form associated with this activity class to set
-
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 theActivityParameterHelper
class for more information on the specific functionality of a helper class.- Returns:
- the helper class
-
setHelperClass
Sets the helper class for this activity class.- Parameters:
helperClass_
- the helper class- See Also:
-
getLocalId
Gets the Activity Class Local ID of this activity class- Returns:
- the Activity Class Local ID of this activity class
-
setLocalId
Sets the Activity Class Local ID of this activity class- Parameters:
localId_
- the Activity Class Local ID of this activity class to set
-