com.appiancorp.suiteapi.process

Class ActivityClassParameter

java.lang.Object

com.appiancorp.suiteapi.type.TypedValue

com.appiancorp.suiteapi.type.NamedTypedValue

com.appiancorp.suiteapi.process.TypedVariable

com.appiancorp.suiteapi.process.ActivityClassParameterSchema

com.appiancorp.suiteapi.process.ActivityClassParameter

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, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ActivityReturnVariable

public class ActivityClassParameter
extends ActivityClassParameterSchema
implements com.appiancorp.process.runtime.forms.FormParameter, Validatable, java.io.Serializable, JSONCacheable, DeepCloneable, com.appiancorp.type.ExpressionableNamedTypedValue

An ActivityClassParameter is a variable that is specified at design time and used at runtime. It is passed into an Activity, and used as a local variable within that scope.

See Also:

ActivityClass, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object[]	_interiorExpressions

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.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.JSONable

hiddenAttributes$TRANSIENT

Fields inherited from interface com.appiancorp.type.NamedType

selectName

Fields inherited from interface com.appiancorp.type.HasTypeRef

selectTypeId

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

DEFAULT_BUFFER_SIZE

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.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

Constructor Summary

Constructors

Constructor and Description
ActivityClassParameter() Creates a new activity class parameter
ActivityClassParameter(ActivityClassParameter acp_)
ActivityClassParameter(ActivityClassParameterSchema schema_)
ActivityClassParameter(NamedTypedValue ntv_)
ActivityClassParameter(java.lang.String name_, java.lang.Long type_, java.lang.Object value_) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addAllMessages(java.util.List newMessages_) Adds all of the messages in the given list to the collection of validation messages maintained by this object.
void	addValidationMessage(java.lang.String message_) Adds the given validation message to the collection maintained by this object.
void	clear() Clear passwords.
void	clearPasswordOnTransport(boolean clear) Deprecated. This is an internal method that will be removed from the public API.
void	clearValidationMessages() Clears the collection of validation messages accumulated by this object.
java.lang.Object	clone() Clone this object.
ActivityClassParameter	copy() Deprecated. Can make copy externally.
static ActivityClassParameter	findParameterByName(ActivityClassParameter[] params_, java.lang.String name_) Finds the parameter in the given array that has the given name.
ActivityClassParameter	getACP(java.lang.String name_)
java.lang.Long	getAcpSchemaId() Gets the Activity Class Parameter ID for this activity class parameter
java.lang.String	getAssignToProcessVariable() Gets the string name of the process variable to which the value of the activity class parameter should be assigned
java.lang.String	getExpression() Gets the expression for this activity class parameter
java.lang.String	getFriendlyName() Gets a name that can be shown to an end user.
boolean	getGenerated() Determines whether this variable cannot be deleted in the designer, if it is a custom ACP.
java.util.HashSet	getHiddenAttributes() Returns the set of attributes (properties) that should not be included in the JSON representation of the object.
java.lang.Object[]	getInteriorExpressions() Gets the array that contains the interior expressions for this activity class parameter
java.util.List	getValidationMessages() Retrieves the list of validation messages that have been added to this object by a validator.
protected java.lang.String	getXMLWrapperName()
boolean	isPasswordStored() Used only for passwords and only in certain circumstances.
void	setAcpSchemaId(java.lang.Long acpSchemaId_) Sets the Activity Class Parameter ID for this activity class parameter
void	setAssignToProcessVariable(java.lang.String saveToPv_) Sets the string name of the process variable to which the value of the activity class parameter should be assigned
protected void	setClearPassword(boolean clear) Deprecated. This is an internal method that will be removed from the public API.
void	setExpression(java.lang.String expression_) Sets the expression for this activity class parameter
void	setGenerated(boolean generated_) Determines whether this variable was generated in the designer.
void	setInteriorExpressions(java.lang.Object[] interiorExpressions_) Sets the interior expressions for this activity class parameter.
void	setValue(java.lang.Object value_) Sets the value of the typed variable.
boolean	shouldClear() Does this ACP need to clear passwords?

Methods inherited from class com.appiancorp.suiteapi.process.ActivityClassParameterSchema

getComment, getCustomDisplayReference, getEnumeration, getHiddenFromDesigner, getId, getInputToAc, getLocalId, getMutable, getNullable, getPrompt, getRequired, isRequired, setComment, setCustomDisplayReference, setEnumeration, setHiddenFromDesigner, setId, setInputToAc, setLocalId, setMutable, setNullable, setPrompt, setRequired, setRequired, toXML

Methods inherited from class com.appiancorp.suiteapi.process.TypedVariable

appendFullName, appendLocalObject, appendLocalObject, appendLocalObjects, appendLocalObjects, children, computeDisplayString, computeDisplayString, computeValueString, computeValueStringForUiOutput, convertFromLocalObjectType, externalize, externalize, fillInAppianTypes, 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, toString, toXML

Methods inherited from class com.appiancorp.suiteapi.type.NamedTypedValue

equals, findNtvByName, findNtvIndexByName, getName, getNtvNames, hashCode, setName, toString

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.process.runtime.forms.FormParameter

getInstanceType, getKey, getMultiple, getValue, isRequired, setDetailedTypes, setRequired

Methods inherited from interface com.appiancorp.suiteapi.process.Validatable

getDetailedTypes, getInstanceType, getKey, getMultiple, getMutable, getNullable, getType, getValue, setDetailedTypes, setInstanceType, setMultiple

Methods inherited from interface com.appiancorp.type.ExpressionableNamedTypedValue

getInstanceType, getValue, setInstanceType

Methods inherited from interface com.appiancorp.type.NamedType

getName, setName

Methods inherited from interface com.appiancorp.type.HasTypeRef

getTypeRef, setTypeRef

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

toXML

Methods inherited from interface com.appiancorp.core.expr.portable.PortableNamedTypedValueWithChildren

setName

Methods inherited from interface com.appiancorp.core.expr.portable.PortableNamedTypedValue

getName

Methods inherited from interface com.appiancorp.core.expr.portable.PortableTypedValue

getInstanceType, getValue

Field Detail

_interiorExpressions

protected java.lang.Object[] _interiorExpressions

Constructor Detail

ActivityClassParameter

public ActivityClassParameter()

Creates a new activity class parameter

ActivityClassParameter

public ActivityClassParameter(NamedTypedValue ntv_)

ActivityClassParameter

@Deprecated
public ActivityClassParameter(java.lang.String name_,
                                          java.lang.Long type_,
                                          java.lang.Object value_)

Deprecated.

Creates a new parameter with the given name, type, and value.

Parameters:

name_ - the name of the parameter to set

type_ - the type of the parameter. This must be one of the constants in TypedVariable.

value_ - the value of the parameter to set.

Throws:

java.lang.IllegalArgumentException - if type_ is not one of the constants from TypedVariable.

See Also:

TypedVariable

ActivityClassParameter

public ActivityClassParameter(ActivityClassParameter acp_)

ActivityClassParameter

public ActivityClassParameter(ActivityClassParameterSchema 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

Overrides:

getHiddenAttributes in class TypedVariable

Returns:

the set of hidden attributes

clone

public java.lang.Object clone()

Clone this object. Note that this will produce a deep copy of value as well.

Specified by:

clone in interface DeepCloneable

Overrides:

clone in class ActivityClassParameterSchema

Returns:

getXMLWrapperName

protected java.lang.String getXMLWrapperName()

Overrides:

getXMLWrapperName in class ActivityClassParameterSchema

findParameterByName

public static ActivityClassParameter findParameterByName(ActivityClassParameter[] params_,
                                                         java.lang.String name_)

Finds the parameter in the given array that has the given name. If no such parameter can be found, returns null.

getAcpSchemaId

public java.lang.Long getAcpSchemaId()

Gets the Activity Class Parameter ID for this activity class parameter

Returns:

the Activity Class Parameter ID for this activity class parameter

setAcpSchemaId

public void setAcpSchemaId(java.lang.Long acpSchemaId_)

Sets the Activity Class Parameter ID for this activity class parameter

Parameters:

acpSchemaId_ - the Activity Class Parameter ID for this activity class parameter

getExpression

public java.lang.String getExpression()

Gets the expression for this activity class parameter

Specified by:

getExpression in interface com.appiancorp.type.ExpressionableNamedTypedValue

Returns:

the expression for this activity class parameter

setExpression

public void setExpression(java.lang.String expression_)

Sets the expression for this activity class parameter

Specified by:

setExpression in interface com.appiancorp.type.ExpressionableNamedTypedValue

Parameters:

expression_ - the expression for this activity class parameter

getValidationMessages

public java.util.List getValidationMessages()

Description copied from interface: Validatable

Retrieves the list of validation messages that have been added to this object by a validator. These messages are Strings.

Specified by:

getValidationMessages in interface com.appiancorp.process.runtime.forms.FormParameter

Specified by:

getValidationMessages in interface Validatable

Returns:

A list of Strings representing the validation messages.

addValidationMessage

public void addValidationMessage(java.lang.String message_)

Description copied from interface: Validatable

Adds the given validation message to the collection maintained by this object. All messages can be retrieved with getValidationMessages().

Specified by:

addValidationMessage in interface com.appiancorp.process.runtime.forms.FormParameter

Specified by:

addValidationMessage in interface Validatable

Parameters:

message_ - The validation message to add.

clearValidationMessages

public void clearValidationMessages()

Description copied from interface: Validatable

Clears the collection of validation messages accumulated by this object. A subsequent call to getValidationMessages() will return an empty list, unless there are intervening calls to addValidationMessage().

Specified by:

clearValidationMessages in interface Validatable

addAllMessages

public void addAllMessages(java.util.List newMessages_)

Description copied from interface: Validatable

Adds all of the messages in the given list to the collection of validation messages maintained by this object.

Specified by:

addAllMessages in interface Validatable

Parameters:

newMessages_ - A list of validation messages to add, each of which is a String .

getFriendlyName

public java.lang.String getFriendlyName()

Description copied from interface: Validatable

Gets a name that can be shown to an end user. In most cases, this is no more complicated than getKey(). Some types of variables, however, have more descriptive text sitting around, and can return that. Basically, end users know about labels, not variable names.

Specified by:

getFriendlyName in interface Validatable

Returns:

The friendly name of the variable as a String.

getAssignToProcessVariable

public java.lang.String getAssignToProcessVariable()

Gets the string name of the process variable to which the value of the activity class parameter should be assigned

Returns:

the string name of the process variable

setAssignToProcessVariable

public void setAssignToProcessVariable(java.lang.String saveToPv_)

Sets the string name of the process variable to which the value of the activity class parameter should be assigned

Parameters:

saveToPv_ - the string name of the process variable to save to (this can be prefixed with pv! e.g., processVar1 or pv!processVar1 both work.)

getGenerated

public boolean getGenerated()

Determines whether this variable cannot be deleted in the designer, if it is a custom ACP. ACPs that are specified at admin-time can never be deleted in the designer. The default is false, which should suffice 99% of the time.

Returns:

true if the user cannot delete this variable

setGenerated

public void setGenerated(boolean generated_)

Determines whether this variable was generated in the designer. The default is false, which should suffice 99% of the time.

Parameters:

generated_ - true if the ACP was generated

setValue

public void setValue(java.lang.Object value_)

Description copied from class: TypedValue

Sets the value of the typed variable.

Specified by:

setValue in interface com.appiancorp.process.runtime.forms.FormParameter

Specified by:

setValue in interface Validatable

Specified by:

setValue in interface com.appiancorp.type.ExpressionableNamedTypedValue

Overrides:

setValue in class TypedVariable

Parameters:

value_ - The value to set the typed variable to.

isPasswordStored

public boolean isPasswordStored()

Used only for passwords and only in certain circumstances. Will not return the correct value under most circumstances. Do not use except within ActivityExecuteAction.

shouldClear

public boolean shouldClear()

Does this ACP need to clear passwords?

Returns:

clear

public void clear()

Clear passwords.

copy

@Deprecated
public ActivityClassParameter copy()

Deprecated. Can make copy externally.

Returns a copy of this ACP and any sub-ACPs. Does NOT perform a full deep copy (e.g., non-ACP arrays are copied by reference)

getACP

public ActivityClassParameter getACP(java.lang.String name_)

setInteriorExpressions

public void setInteriorExpressions(java.lang.Object[] interiorExpressions_)

Sets the interior expressions for this activity class parameter. These are only valid when dealing with TypedValues that are records, and the structure should mimic the one inside the Value field (an array of strings that is the length of the Record type's instance properties, with another array of strings in the case of instance properties that are also record types. These expressions will be evaluated when assigning the value to the ACP. A null value must be specified where no expression is desired.

Parameters:

interiorExpressions_ - the array with the Interior Expressions.

getInteriorExpressions

public java.lang.Object[] getInteriorExpressions()

Gets the array that contains the interior expressions for this activity class parameter

Returns:

the interior expressions object array

clearPasswordOnTransport

@Deprecated
public void clearPasswordOnTransport(boolean clear)

Deprecated. This is an internal method that will be removed from the public API.

Set whether or not to this value should clear passwords on transport (i.e. when passed to the back-end). Transient property. Works as a flag to avoid including passwords in transport.

Parameters:

clear -

setClearPassword

@Deprecated
protected void setClearPassword(boolean clear)

Deprecated. This is an internal method that will be removed from the public API.