com.appiancorp.suiteapi.process

Class ActivityClassParameterSchema

java.lang.Object

com.appiancorp.suiteapi.type.TypedValue

com.appiancorp.suiteapi.type.NamedTypedValue

com.appiancorp.suiteapi.process.TypedVariable

com.appiancorp.suiteapi.process.ActivityClassParameterSchema

All Implemented Interfaces:

com.appiancorp.core.expr.portable.PortableNamedTypedValue, com.appiancorp.core.expr.portable.PortableNamedTypedValueWithChildren, com.appiancorp.core.expr.portable.PortableTypedValue, DeepCloneable, JSONable, JSONCacheable, XMLable, AppianTypeHolder, TypedVariableTypes, AppianType, com.appiancorp.type.HasTypeRef, com.appiancorp.type.NamedType, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ActivityClassParameter

public class ActivityClassParameterSchema
extends TypedVariable
implements DeepCloneable

Template from which ActivityClassParameters are created. When an administrator adds a new activity to the system, he or she is specifying a new ActivityClassSchema. When a designer adds a node to a process model, he or she is using an ActivityClass (or multiple classes, if there are pre-and post-activities). An ActivityClassParameterSchema is held by an ActivityClassSchema to supply data to the process designer to govern the options available to the person doing the design. An ActivityClassParameterSchema can have a type of DEFERRED, which will force the designer to choose another type for each corresponding ActivityClassParameter. If the type is BEAN_ARRAY, the value must be a single ActivityClassParameterSchema of type BEAN which specifies the layout to which all ActivityClassParameters created from this schema must conform.

See Also:

Serialized Form

Field Summary

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

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

hiddenAttributes$TRANSIENT

Constructor Summary

Constructors

Constructor and Description
ActivityClassParameterSchema()
ActivityClassParameterSchema(NamedTypedValue ntv_)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone this object.
java.lang.String	getComment() Gets the comment for this activity class parameter schema
java.lang.String	getCustomDisplayReference() Retrieves the name of the pickerType to be used for this ACPS.
java.lang.String	getEnumeration() Retrieves the name (key) of the enumeration to be used for this ACPS.
boolean	getHiddenFromDesigner() Determines whether the data tab on the process modeler will show this parameter to the designer.
java.lang.Long	getId() Gets the unique Id for this activity class parameter schema
boolean	getInputToAc() Determines whether this parameter is input to an activity class (and therefore a true activity class parameter), or not (and therefore an activity return variable).
java.lang.String	getLocalId() Gets the local id of the activity class parameter schema on the system.
java.lang.Long	getMutable() Indicates whether the activity class parameter can be changed
java.lang.Long	getNullable() Indicates whether or not this activity class parameter schema is nullable
java.lang.String	getPrompt() Gets the default prompt to be show to the runtime user for parameters created from this schema.
java.lang.Long	getRequired() Deprecated. Use isRequired()
protected java.lang.String	getXMLWrapperName()
boolean	isRequired() Returns true if the parameter is required, false otherwise.
void	setComment(java.lang.String comment_) Sets the comment for this activity class parameter schema
void	setCustomDisplayReference(java.lang.String customDisplayReference_) Sets the name of the pickerType to be used for this ACPS.
void	setEnumeration(java.lang.String enumeration_) Sets the name (key) of the enumeration to be used for this ACPS.
void	setHiddenFromDesigner(boolean hidden_) Determines whether the data tab on the process modeler will show this parameter to the designer.
void	setId(java.lang.Long id_) Sets the unique Id for this activity class parameter schema
void	setInputToAc(boolean inputToAc_) Sets whether or not this acp-schema is an input to an activity class (and therefore a true activity class parameter), or not (and is therefore an activity return variable)
void	setLocalId(java.lang.String localId_) Sets the local id of the activity class parameter schema on the system.
void	setMutable(java.lang.Long mutable_) Sets whether this activity class parameter can be changed
void	setNullable(java.lang.Long nullable_) Sets whether or not this activity class parameter schema is nullable
void	setPrompt(java.lang.String prompt_) Sets the default prompt to be shown to runtime users of activites containing parameters created from this schema.
void	setRequired(boolean required) Sets whether this parameter is required.
void	setRequired(java.lang.Long required_) Deprecated. Use setRequired(boolean)
void	toXML(java.lang.StringBuilder buffer_) Appends the XML representation of this typed variable to the given buffer.

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, getHiddenAttributes, 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

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

Methods inherited from interface com.appiancorp.type.HasTypeRef

getTypeRef, setTypeRef

Constructor Detail

ActivityClassParameterSchema

public ActivityClassParameterSchema()

ActivityClassParameterSchema

public ActivityClassParameterSchema(NamedTypedValue ntv_)

Method Detail

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 TypedValue

Returns:

setHiddenFromDesigner

public void setHiddenFromDesigner(boolean hidden_)

Determines whether the data tab on the process modeler will show this parameter to the designer. A non-zero value means "yes", a zero value means "no".

Parameters:

hidden_ - whether or not the

getHiddenFromDesigner

public boolean getHiddenFromDesigner()

Determines whether the data tab on the process modeler will show this parameter to the designer. A non-zero value means "yes", a zero value means "no".

Parameters:

hidden_ - whether or not the

getRequired

@Deprecated
public java.lang.Long getRequired()

Deprecated. Use isRequired()

Indicates whether the activity class parameter is required or not

Returns:

a Long indicating whether the the activity class parameter is required or not (0 - not required, 1 - required, 2 - required but all except admins and designers)

setRequired

@Deprecated
public void setRequired(java.lang.Long required_)

Deprecated. Use setRequired(boolean)

Sets whether the activity class parameter is required or not

Parameters:

required_ - a Long indicating whether the the activity class parameter is required or not (0 - not required, 1 - required, 2 - required but all except admins and designers)

isRequired

public boolean isRequired()

Returns true if the parameter is required, false otherwise.

Since:

6.6.2

setRequired

public void setRequired(boolean required)

Sets whether this parameter is required.

Parameters:

required - True if it's required

Since:

6.6.2

getXMLWrapperName

protected java.lang.String getXMLWrapperName()

Overrides:

getXMLWrapperName in class TypedVariable

toXML

public void toXML(java.lang.StringBuilder buffer_)

Description copied from class: TypedVariable

Appends the XML representation of this typed variable to the given buffer.

Specified by:

toXML in interface XMLable

Overrides:

toXML in class TypedVariable

Parameters:

buffer_ - The buffer to which the typed variable should be appended.

getId

public java.lang.Long getId()

Gets the unique Id for this activity class parameter schema

Returns:

the unique Id for this activity class parameter schema

setId

public void setId(java.lang.Long id_)

Sets the unique Id for this activity class parameter schema

Parameters:

id_ - the unique Id to set for this activity class parameter schema

getNullable

public java.lang.Long getNullable()

Indicates whether or not this activity class parameter schema is nullable

Returns:

whether or not this activity class parameter schema is nullable. Will return one fo the following values: Validatable.NULLABLE_NOT_AT_ALL, Validatable.NULLABLE_BY_ALL, Validatable.NULLABLE_ADMIN_AND_DESIGN

setNullable

public void setNullable(java.lang.Long nullable_)

Sets whether or not this activity class parameter schema is nullable

Parameters:

nullable_ - value to set for whether the activity class parameter Allowed values are: Validatable.NULLABLE_NOT_AT_ALL, Validatable.NULLABLE_BY_ALL , Validatable.NULLABLE_ADMIN_AND_DESIGN

getComment

public java.lang.String getComment()

Gets the comment for this activity class parameter schema

Returns:

the comment for this activity class parameter schema

setComment

public void setComment(java.lang.String comment_)

Sets the comment for this activity class parameter schema

Parameters:

comment_ - the comment to set for this activity class parameter schema

getInputToAc

public boolean getInputToAc()

Determines whether this parameter is input to an activity class (and therefore a true activity class parameter), or not (and therefore an activity return variable).

Returns:

true if this parameter is an input to an activity class, false otherwise

setInputToAc

public void setInputToAc(boolean inputToAc_)

Sets whether or not this acp-schema is an input to an activity class (and therefore a true activity class parameter), or not (and is therefore an activity return variable)

Parameters:

inputToAc_ - true if this parameter is an input to an activity class, false otherwise

getMutable

public java.lang.Long getMutable()

Indicates whether the activity class parameter can be changed

Returns:

a Long which indicates whether this activity class parameter is mutable. Will return one fo the following values: Validatable.MUTABLE_NOT_BY_END_USER, Validatable.MUTABLE_BY_END_USER, Validatable.MUTABLE_AT_DESIGNER_DISCRETION

setMutable

public void setMutable(java.lang.Long mutable_)

Sets whether this activity class parameter can be changed

Parameters:

mutable_ - a Long which indicates whether this activity class parameter is mutable. Allowed values are : Validatable.MUTABLE_NOT_BY_END_USER, Validatable.MUTABLE_BY_END_USER, Validatable.MUTABLE_AT_DESIGNER_DISCRETION

getPrompt

public java.lang.String getPrompt()

Gets the default prompt to be show to the runtime user for parameters created from this schema. The process designer can override this default on each parameter instance.

Returns:

the default prompt to be show to the user

setPrompt

public void setPrompt(java.lang.String prompt_)

Sets the default prompt to be shown to runtime users of activites containing parameters created from this schema.

Parameters:

prompt_ - the default prompt to be show to the user

getLocalId

public java.lang.String getLocalId()

Gets the local id of the activity class parameter schema on the system.

Returns:

Returns the localId.

setLocalId

public void setLocalId(java.lang.String localId_)

Sets the local id of the activity class parameter schema on the system.

Parameters:

localId_ - The localId to set.

getEnumeration

public java.lang.String getEnumeration()

Retrieves the name (key) of the enumeration to be used for this ACPS. If no enumeration is to be used this method will return null.

Returns:

Returns the enumeration.

setEnumeration

public void setEnumeration(java.lang.String enumeration_)

Sets the name (key) of the enumeration to be used for this ACPS.

Parameters:

enumeration_ - The enumeration to set.

See Also:

getEnumeration()

getCustomDisplayReference

public java.lang.String getCustomDisplayReference()

Retrieves the name of the pickerType to be used for this ACPS. If set, a custom pickerType will be used to choose the value of this ACPS at design time and run time. The return type of the picker must match the type of the ACPS, ie. an ACPS of type Group must have some type of Group picker. If not set, the ACPS will use the default picker for its type.
Note: If the type of the ACPS is not an Appian type, this field will also be ignored.

Returns:

Returns the customDisplayReference.

setCustomDisplayReference

public void setCustomDisplayReference(java.lang.String customDisplayReference_)

Sets the name of the pickerType to be used for this ACPS.

Parameters:

customDisplayReference_ - The customDisplayReference to set.

See Also:

getCustomDisplayReference()