Package com.appiancorp.suiteapi.process
Class ActivityClassSchema
java.lang.Object
com.appiancorp.suiteapi.common.Identity
com.appiancorp.suiteapi.process.ActivityClassSchema
- All Implemented Interfaces:
JSONable
,JSONCacheable
,LocalId
,XMLable
,Serializable
The template from which activity classes are created.
When a system administrator addes a new activity to the system, an instance
of this class is used to represent that activity. When a process designer
puts a node in a process model, he or she is using an ActivityClass, which
has a reference to this schema. The schema specifies what the parameters
of an activity are and some of the restrictions on those parameters that
constrain the designer's behavior.
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Constant indicating that activities of this schema can be run asynchronously.static final int
Constant indicating that activities of this schema must be attended.static final int
Constant indicating that designers can choose whether activities of this schema are be attended or unattended.static final Integer
Constant indicating a Java execution environment.static final Integer
Constant indicating a Process execution engine environment.static final int
Constant indicating that activities of this schema cannot be run asynchronously.static final int
Constant indicating that activities of this schema are for to perform task assignment only.static final int
Constant indicating that activities of this schema are for to perform task assignment only.static final int
Constant indicating that activities of this schema are escalations.static final int
Constant indicating that nodes containing activities of this schema are smart noded.static final int
Constant indicating that activities of this schema are subprocesses.static final int
Constant indicating that activities of this schema are for internal system use only.static final int
Constant indicating that activities of this schema must 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
-
Method Summary
Modifier and TypeMethodDescriptionstatic ActivityClassSchema
findByLocalId
(ActivityClassSchema[] schemas, String localId) int
Indicates whether activities of this schema be run asynchronously.Gets the URL for the custom setup tabGets the the execution environment for this activity class schemagetFormConfig
(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 schema.Gets the k function for this activity class schemaGets the helper class for this activity class schema.Returns the set of attributes (properties) that should not be included in the JSON representation of the object.Gets the local id of the activity class schema on the system.Gets the parameters used by activities that conform to this schema.Gets the return variables for this activity class schemaint
getType()
Gets the type for this activity class schema.Indicates whether the activity class schema requires user interaction to completeboolean
Indicates whether this schema is a template for a particular web service (Not in use)void
setAsynchronous
(int asynchronous_) Sets whether activities of this schema be run asynchronously.void
setCustomSetupUrl
(String customSetupUrl_) Sets the URL for the custom setup tabvoid
setExecutionEnvironmentId
(Integer executionEnvironmentId_) sets the executionEnvironment for this ac-schemavoid
setFormConfigMap
(FormConfigMap formConfigMap_) Sets the information about the form associated with this activity class schemavoid
setFunction
(String function_) Sets the k function for this activity class schemavoid
setHelperClass
(String parameterHelperClassname_) Sets the helper class for this activity class schema.void
setJavaClassName
(String javaClassName_) sets the java class name for this ac-schemavoid
setLocalId
(String localId_) Sets the local id of the activity class schema on the system.void
setParameters
(ActivityClassParameterSchema[] parameters_) Sets the parameters used by activities that conform to this schema.void
setReturnValues
(ActivityReturnVariable[] returnValues_) Sets the return variables for this activity class schemavoid
setTemplate
(boolean template_) Sets whether this schema a template for a particular web servicevoid
setType
(int type_) Sets the type for this activity class schema.void
setUnattended
(Long unattended_) Sets whether the activity class schema requires user interaction to completetoXML()
Generates an XML representation of this object (including all child objects).void
toXML
(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, toString
-
Field Details
-
ENVIRONMENT_PROCESS_EXECUTION_ENGINE
Constant indicating a Process execution engine environment. -
ENVIRONMENT_JAVA
Constant indicating a Java execution environment. -
ATTENDED
public static final int ATTENDEDConstant indicating that activities of this schema must be attended.- See Also:
-
UNATTENDED
public static final int UNATTENDEDConstant indicating that activities of this schema must be unattended.- See Also:
-
ATTENDED_AND_UNATTENDED
public static final int ATTENDED_AND_UNATTENDEDConstant indicating that designers can choose whether activities of this schema are be attended or unattended.- See Also:
-
TYPE_SYSTEM
public static final int TYPE_SYSTEMConstant indicating that activities of this schema are for internal system use only.- See Also:
-
TYPE_ASSIGNMENT
public static final int TYPE_ASSIGNMENTConstant indicating that activities of this schema are for to perform task assignment only.- See Also:
-
TYPE_ASSIGNEE_POOL
public static final int TYPE_ASSIGNEE_POOLConstant indicating that activities of this schema are for to perform task assignment only.- See Also:
-
TYPE_SMART_NODES
public static final int TYPE_SMART_NODESConstant indicating that nodes containing activities of this schema are smart noded.- See Also:
-
TYPE_SUBPROCESS
public static final int TYPE_SUBPROCESSConstant indicating that activities of this schema are subprocesses.- See Also:
-
TYPE_ESCALATIONS
public static final int TYPE_ESCALATIONSConstant indicating that activities of this schema are escalations.- See Also:
-
ASYNCHRONOUS
public static final int ASYNCHRONOUSConstant indicating that activities of this schema can be run asynchronously.- See Also:
-
SYNCHRONOUS
public static final int SYNCHRONOUSConstant indicating that activities of this schema cannot be run asynchronously.- See Also:
-
-
Constructor Details
-
ActivityClassSchema
public ActivityClassSchema()
-
-
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 parameters used by activities that conform to this schema. These parameters can have a type of DEFERRED, and any BEAN_ARRAY parameters have a size of exactly 1, with the value field holding another ActivityClassParameterSchema that is of type BEAN, providing the layout of the beans to be contained in the array at design time.- Returns:
- an array of
ActivityClassParameterSchema
objects representing the parameters for this activity class schema - See Also:
-
setParameters
Sets the parameters used by activities that conform to this schema. These parameters can have a type of DEFERRED, and any BEAN_ARRAY parameters have a size of exactly 1, with the value field holding another ActivityClassParameterSchema that is of type BEAN, providing the layout of the beans to be contained in the array at design time.- Parameters:
parameters_
- an array ofActivityClassParameterSchema
objects representing the parameters for this activity class schema- See Also:
-
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. -
getFunction
Gets the k function for this activity class schema- Returns:
- the k function user for this activity class schema
-
setFunction
Sets the k function for this activity class schema- Parameters:
function_
- the k function for this activity class schema
-
getExecutionEnvironmentId
Gets the the execution environment for this activity class schema- Returns:
- the execution environment for this activity class schema. Possible
values are :
ENVIRONMENT_JAVA
,ActivityClassSchema#ENVIRONMENT_K
-
setExecutionEnvironmentId
sets the executionEnvironment for this ac-schema- Parameters:
executionEnvironmentId_
- tthe execution environment for this activity class schema. Allowed values are :ENVIRONMENT_JAVA
,ActivityClassSchema#ENVIRONMENT_K
-
getJavaClassName
- Returns:
- the java classname for this ac-schema
-
setJavaClassName
sets the java class name for this ac-schema- Parameters:
javaClassName_
- the javaClassName to set for this ac-schema
-
getUnattended
Indicates whether the activity class schema requires user interaction to complete- Returns:
ATTENDED
if the activity class schema is attended (requires human interaction),UNATTENDED
if the activity class schema is unattended,ATTENDED_AND_UNATTENDED
if it can be both
-
setUnattended
Sets whether the activity class schema requires user interaction to complete- Parameters:
unattended_
- value to set for whether this ac-schema is unattended. Allowed values are:ATTENDED
if the activity class schema is attended (requires human interaction),UNATTENDED
if the activity class schema is unattended,ATTENDED_AND_UNATTENDED
if it can be both
-
setHelperClass
Sets the helper class for this activity class schema.- Parameters:
parameterHelperClassname_
- the helper class- See Also:
-
getHelperClass
Gets the helper class for this activity class schema. 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
-
getType
public int getType()Gets the type for this activity class schema. Possible values are in the set ofActivityClassSchema.TYPE_XXX
- Returns:
- the Type of this activity class schema
-
setType
public void setType(int type_) Sets the type for this activity class schema. Allowed values are in the set ofActivityClassSchema.TYPE_XXX
- Parameters:
type_
- the Type of this activity class schema to set
-
getReturnValues
Gets the return variables for this activity class schema- Returns:
- an array of
ActivityReturnVariable
objects representing the return values of the activity class schema - See Also:
-
setReturnValues
Sets the return variables for this activity class schema- Parameters:
returnValues_
- an array ofActivityReturnVariable
objects representing the return values of the activity class schema- See Also:
-
getFormConfigMap
Gets the information about the form associated with this activity class schema.- Returns:
- a
FormConfig
object that represents information about the form associated with this activity class schema - 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 schema- Parameters:
formConfig_
- aFormConfig
object that represents information about the form associated with this activity class schema to set
-
getLocalId
Gets the local id of the activity class schema on the system.- Returns:
- Returns the localId.
-
setLocalId
Sets the local id of the activity class schema on the system.- Parameters:
localId_
- The localId to set.
-
getAsynchronous
public int getAsynchronous()Indicates whether activities of this schema be run asynchronously.- Returns:
- an integer which indicates whether activities of this schema be
run asynchronously.
Will return one fo the following values:
ASYNCHRONOUS
,SYNCHRONOUS
-
setAsynchronous
public void setAsynchronous(int asynchronous_) Sets whether activities of this schema be run asynchronously.- Parameters:
asynchronous_
- an integer which indicates whether activities of this schema be run asynchronously. Allowed values are:ASYNCHRONOUS
,SYNCHRONOUS
,
-
getCustomSetupUrl
Gets the URL for the custom setup tab- Returns:
- the URL for the custom setup tab.
-
setCustomSetupUrl
Sets the URL for the custom setup tab- Parameters:
customSetupUrl_
- he URL for the custom setup tab to set.
-
isTemplate
public boolean isTemplate()Indicates whether this schema is a template for a particular web service (Not in use)- Returns:
true
if this schema a template for a particular web service,false
otherwise
-
setTemplate
public void setTemplate(boolean template_) Sets whether this schema a template for a particular web service- Parameters:
template_
-true
if this schema a template for a particular web service,false
otherwise.
-
findByLocalId
-