Package com.appiancorp.suiteapi.process
Class ProcessVariableInstance
java.lang.Object
com.appiancorp.suiteapi.type.TypedValue
com.appiancorp.suiteapi.type.NamedTypedValue
com.appiancorp.suiteapi.process.TypedVariable
com.appiancorp.suiteapi.process.ProcessVariable
com.appiancorp.suiteapi.process.ProcessVariableInstance
- All Implemented Interfaces:
com.appiancorp.core.expr.portable.PortableNamedTypedValue
,com.appiancorp.core.expr.portable.PortableNamedTypedValueWithChildren
,com.appiancorp.core.expr.portable.PortableTypedValue
,com.appiancorp.process.runtime.forms.FormParameter
,DeepCloneable
,JSONable
,JSONCacheable
,XMLable
,AppianTypeHolder
,TypedVariableTypes
,Validatable
,AppianType
,com.appiancorp.type.ExpressionableNamedTypedValue
,com.appiancorp.type.HasTypeRef
,com.appiancorp.type.NamedType
,Serializable
,Cloneable
,Comparable
public class ProcessVariableInstance
extends ProcessVariable
implements AppianTypeHolder, DeepCloneable
Represents the runtime instance of process variable for a process. This object
is used in the inflight modification of the process, which can view/change
the value of the process variable.
- See Also:
-
Field Summary
Fields inherited from class com.appiancorp.suiteapi.process.ProcessVariable
SORT_BY_HIDDEN, SORT_BY_ID, SORT_BY_KEY, SORT_BY_MULTIPLE, SORT_BY_PARAMETER, SORT_BY_REQUIRED, SORT_BY_TYPE, SORT_BY_VALUE
Fields inherited from class com.appiancorp.suiteapi.process.TypedVariable
classType$TRANSIENT, dataType$TRANSIENT, detailedTypes$TRANSIENT, displayName$TRANSIENT, LOCAL_COMMUNITY, LOCAL_DOCUMENT, LOCAL_EMAIL_ADDRESS, LOCAL_FOLDER, LOCAL_FORUM, LOCAL_GROUP, LOCAL_KC, LOCAL_MESSAGE, LOCAL_NODE, LOCAL_PAGE, LOCAL_PM, LOCAL_PORTLET, LOCAL_PROCESS, LOCAL_TASK, LOCAL_TOPIC, LOCAL_USER, MAX_TYPE, multipleSupportingType$TRANSIENT
Fields inherited from class com.appiancorp.suiteapi.type.NamedTypedValue
QNAME
Fields inherited from class com.appiancorp.suiteapi.type.TypedValue
ALWAYS, AT_DESIGNER_DISCRETION, clearPasswordOnTransport, NEVER, TO_STRING_STYLE
Fields inherited from interface com.appiancorp.suiteapi.type.AppianType
ADMINISTERED_PROPERTY, ALIAS, APPLICATION, ARRAY, ATTACHMENT, BEAN, BIG_RATIONAL, BINARY, BOOLEAN, CHART_COLOR, COMMUNITY, CONNECTED_SYSTEM, CONTENT_COMMUNITY, CONTENT_CONSTANT, CONTENT_CUSTOM, CONTENT_DOCUMENT, CONTENT_FOLDER, CONTENT_FREEFORM_RULE, CONTENT_ITEM, CONTENT_KNOWLEDGE_CENTER, CONTENT_RULE, CURRENCY, DATA_SOURCE, DATA_STORE, DATA_STORE_ENTITY, DATATYPE, DATE, DECISION, DECISION_TABLE, DECRYPTED_TEXT, DEFERRED, DICTIONARY, DISCUSSION_THREAD, DOCUMENT, DOCUMENT_OR_FOLDER, DOUBLE, EMAIL_ADDRESS, EMAIL_RECIPIENT, EMBEDDED_SAIL_THEME_ID, ENCRYPTED_TEXT, EVENT, EXPRESSION, EXTERNAL_REFERENCE, EXTERNAL_REFERENCE_WITH_INDICES, EXTERNAL_SYSTEM_ID, FIXED, FOLDER, FORUM, GROUP, GROUP_TYPE, ID_REFERENCE, INITIAL_CUSTOM_TYPE, INTEGER, INTEGER_KEY, INTERFACE, INTERVAL_D_S, KNOWLEDGE_CENTER, LINKS_CHANNEL_FOLDER, LIST, LIST_OF_ADMINISTERED_PROPERTY, LIST_OF_APPLICATION, LIST_OF_ATTACHMENT, LIST_OF_BEAN, LIST_OF_BIG_RATIONAL, LIST_OF_BINARY, LIST_OF_BOOLEAN, LIST_OF_CHART_COLOR, LIST_OF_COMMUNITY, LIST_OF_CONNECTED_SYSTEM, LIST_OF_CONTENT_COMMUNITY, LIST_OF_CONTENT_CONSTANT, LIST_OF_CONTENT_CUSTOM, LIST_OF_CONTENT_DOCUMENT, LIST_OF_CONTENT_FOLDER, LIST_OF_CONTENT_FREEFORM_RULE, LIST_OF_CONTENT_ITEM, LIST_OF_CONTENT_KNOWLEDGE_CENTER, LIST_OF_CONTENT_RULE, LIST_OF_CURRENCY, LIST_OF_DATA_SOURCE, LIST_OF_DATA_STORE, LIST_OF_DATA_STORE_ENTITY, LIST_OF_DATATYPE, LIST_OF_DATE, LIST_OF_DECISION, LIST_OF_DECISION_TABLE, LIST_OF_DECRYPTED_TEXT, LIST_OF_DEFERRED, LIST_OF_DICTIONARY, LIST_OF_DISCUSSION_THREAD, LIST_OF_DOCUMENT, LIST_OF_DOCUMENT_OR_FOLDER, LIST_OF_DOUBLE, LIST_OF_EMAIL_ADDRESS, LIST_OF_EMAIL_RECIPIENT, LIST_OF_EMBEDDED_SAIL_THEME_ID, LIST_OF_ENCRYPTED_TEXT, LIST_OF_EVENT, LIST_OF_EXPRESSION, LIST_OF_EXTERNAL_REFERENCE, LIST_OF_EXTERNAL_REFERENCE_WITH_INDICES, LIST_OF_EXTERNAL_SYSTEM_ID, LIST_OF_FIXED, LIST_OF_FOLDER, LIST_OF_FORUM, LIST_OF_GROUP, LIST_OF_GROUP_TYPE, LIST_OF_ID_REFERENCE, LIST_OF_INTEGER, LIST_OF_INTEGER_KEY, LIST_OF_INTERFACE, LIST_OF_INTERVAL_D_S, LIST_OF_KNOWLEDGE_CENTER, LIST_OF_LINKS_CHANNEL_FOLDER, LIST_OF_MAP, LIST_OF_MESSAGE, LIST_OF_NOTE, LIST_OF_NULL, LIST_OF_OUTBOUND_INTEGRATION, LIST_OF_PAGE, LIST_OF_PASSWORD, LIST_OF_PORTLET, LIST_OF_PROCESS, LIST_OF_PROCESS_ERROR, LIST_OF_PROCESS_MODEL, LIST_OF_PROCESS_MODEL_FOLDER, LIST_OF_QUERY_RULE, LIST_OF_QUICK_APP, LIST_OF_RANGE, LIST_OF_RECORD, LIST_OF_RECORD_REFERENCE, LIST_OF_RECORD_TYPE_ID, LIST_OF_RICH_TEXT, LIST_OF_RULE_FOLDER, LIST_OF_SAFE_URI, LIST_OF_SITE, LIST_OF_STRING, LIST_OF_STRING_KEY, LIST_OF_TASK, LIST_OF_TASK_REPORT, LIST_OF_TEMPO_FEED, LIST_OF_TEMPO_REPORT, LIST_OF_TIME, LIST_OF_TIMESTAMP, LIST_OF_TYPE, LIST_OF_UNIFORM_FOLDER, LIST_OF_UNION, LIST_OF_USER_OR_GROUP, LIST_OF_USERNAME, LIST_OF_VARIANT, LIST_OF_WEB_API, MAP, MESSAGE, NOTE, NULL, OUTBOUND_INTEGRATION, PAGE, PASSWORD, PORTLET, PROCESS, PROCESS_ERROR, PROCESS_MODEL, PROCESS_MODEL_FOLDER, QUERY_RULE, QUICK_APP, RANGE, RECORD, RECORD_REFERENCE, RECORD_TYPE_ID, RICH_TEXT, RULE_FOLDER, SAFE_URI, SITE, STRING, STRING_KEY, TASK, TASK_REPORT, TEMPO_FEED, TEMPO_REPORT, TIME, TIMESTAMP, TYPE, UI_CONTAINER, UNIFORM_FOLDER, UNION, USER_OR_GROUP, USERNAME, VARIANT, WEB_API
Fields inherited from interface com.appiancorp.type.HasTypeRef
selectTypeId
Fields inherited from interface com.appiancorp.suiteapi.common.JSONable
hiddenAttributes$TRANSIENT
Fields inherited from interface com.appiancorp.type.NamedType
selectName
Fields inherited from interface com.appiancorp.suiteapi.process.TypedVariableTypes
CONSTANT, CONTENT, CUSTOM_CONTENT_ITEM, DATETIME, DURATION, FREEFORM_RULE, LONG, PEOPLE, PROCESSMODEL_FOLDER, RULE, TEMPLATE, USER
Fields inherited from interface com.appiancorp.suiteapi.process.Validatable
MUTABLE_AT_DESIGNER_DISCRETION, MUTABLE_BY_END_USER, MUTABLE_NOT_BY_END_USER, NULLABLE_ADMIN_AND_DESIGN, NULLABLE_BY_ALL, NULLABLE_NOT_AT_ALL
Fields inherited from interface com.appiancorp.suiteapi.common.XMLable
DEFAULT_BUFFER_SIZE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionclone()
Clone this object.void
fillInAppianTypes
(AppianTypeCache cache_) If this typed variable is an Appian Type, adds its primary key to the cache.Deprecated.Retrieves the current value of the process variable.void
setRunningType
(Long runningType) Deprecated.UseTypedVariable.setInstanceType(Long)
instead.void
setRunningValue
(Object runningValue_) Sets the value of the process variable.toString()
Methods inherited from class com.appiancorp.suiteapi.process.ProcessVariable
addAllMessages, addValidationMessage, clearValidationMessages, compareTo, getExpression, getFriendlyName, getHiddenAttributes, getMutable, getNullable, getValidationMessages, getXMLWrapperName, isHidden, isParameter, isRequired, setExpression, setHidden, setParameter, setRequired
Methods inherited from class com.appiancorp.suiteapi.process.TypedVariable
appendFullName, appendLocalObject, appendLocalObject, appendLocalObjects, appendLocalObjects, children, computeDisplayString, computeDisplayString, computeValueString, computeValueStringForUiOutput, convertFromLocalObjectType, externalize, externalize, findAllWithKeyPrefix, findByName, getClassType, getDataType, getDefaultPvValue, getDefaultValue, getDetailedTypes, getInstanceClass, getKey, getMultiple, getNumericTypedObjectFromUiInput, getObjectTypeMappingFromType, getScalarTypedObject, getScalarTypedObject, getType, getTypedObjectFromUiInput, getTypedObjects, getTypedObjectsFromUiInput, getTypedVariables, getTypeForClass, getTypeFromObjectTypeMappingType, getUnderlyingClass, getXMLWrapperEnd, getXMLWrapperStart, handleTimestampValue, handleTimestampValueForUiOutput, integerToLong, internalize, isAppianType, isMultipleSupportingType, isNotDeferred, isValidType, putOrAppendTimestamp, putOrAppendValue, renderArrayAsCsv, renderArrayAsCsv, renderArrayAsCsv, renderArrayAsCsv, renderArrayAsCsvForUiOutput, renderArrayAsString, setDetailedTypes, setInstanceType, setKey, setMultiple, setType, setTypeMultiple, setValue, toString, toXML, toXML
Methods inherited from class com.appiancorp.suiteapi.type.NamedTypedValue
equals, findNtvByName, findNtvIndexByName, getName, getNtvNames, hashCode, setName
Methods inherited from class com.appiancorp.suiteapi.type.TypedValue
clearPasswordOnTransport, getInstanceType, getInstanceTypeIds, getTypeRef, getValue, setTypeRef
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.appiancorp.type.ExpressionableNamedTypedValue
getInstanceType, getValue, setInstanceType, setValue
Methods inherited from interface com.appiancorp.process.runtime.forms.FormParameter
getInstanceType, getKey, getMultiple, getValue, setDetailedTypes, setValue
Methods inherited from interface com.appiancorp.type.HasTypeRef
getTypeRef, setTypeRef
Methods inherited from interface com.appiancorp.type.NamedType
getName, setName
Methods inherited from interface com.appiancorp.core.expr.portable.PortableNamedTypedValue
getName
Methods inherited from interface com.appiancorp.core.expr.portable.PortableNamedTypedValueWithChildren
setName
Methods inherited from interface com.appiancorp.core.expr.portable.PortableTypedValue
getInstanceType, getValue
Methods inherited from interface com.appiancorp.suiteapi.process.Validatable
getDetailedTypes, getInstanceType, getKey, getMultiple, getType, getValue, setDetailedTypes, setInstanceType, setMultiple, setValue
-
Constructor Details
-
ProcessVariableInstance
public ProcessVariableInstance() -
ProcessVariableInstance
-
-
Method Details
-
clone
Clone this object. Note that this will produce a deep copy of value and runningValue.- Specified by:
clone
in interfaceDeepCloneable
- Overrides:
clone
in classProcessVariable
- Returns:
-
getRunningType
Deprecated.UseTypedValue.getInstanceType()
instead.Retrieves the current type value of the process variable.- Returns:
- the current type value of the process variable
- See Also:
-
setRunningType
Deprecated.UseTypedVariable.setInstanceType(Long)
instead.Sets the current type value of the process variable.- Parameters:
runningValue_
- the new type value of the process variable.- See Also:
-
getRunningValue
Retrieves the current value of the process variable. The 'value' of the process variable can change during the life time of the process. This property holds the most current value of the process variable.- Returns:
- the current value of the process variable
- See Also:
-
setRunningValue
Sets the value of the process variable.- Parameters:
runningValue_
- new value of the process variable.- See Also:
-
fillInAppianTypes
Description copied from class:TypedVariable
If this typed variable is an Appian Type, adds its primary key to the cache.- Specified by:
fillInAppianTypes
in interfaceAppianTypeHolder
- Overrides:
fillInAppianTypes
in classTypedVariable
- Parameters:
cache_
- The cache to add to.
-
toString
- Overrides:
toString
in classNamedTypedValue
-
TypedValue.getInstanceType()
instead.