Package com.appiancorp.suiteapi.messaging

Class MessagePropertySchema

java.lang.Object

com.appiancorp.suiteapi.messaging.MessagePropertySchema

All Implemented Interfaces:

TypedVariableTypes, AppianType

public class MessagePropertySchema
extends Object
implements TypedVariableTypes

Represents a schema for a header property of a JMS message.

Field Summary

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.suiteapi.process.TypedVariableTypes

CONSTANT, CONTENT, CUSTOM_CONTENT_ITEM, DATETIME, DURATION, FREEFORM_RULE, LONG, PEOPLE, PROCESSMODEL_FOLDER, RULE, TEMPLATE, USER

Constructor Summary

Constructors

Constructor	Description
MessagePropertySchema()

Method Summary

Modifier and Type	Method	Description
String	getName()	Gets the name (key).
Long	getType()	Gets the data type.
boolean	isInputFromModeler()	Gets whether this parameter can be input from the Modeler (whether it shows up in the Message Properties Grid on the Data tab of the Send Messages dialog).
boolean	isMultiple()	Gets whether the parameters created from this schema can contain multiple values.
boolean	isRequired()	Gets whether the message property is required.
boolean	isVisibleOnReceiveMessage()	Returns whether the message property is visible on the Receive Message Node in modeler.
void	setInputFromModeler(boolean inputFromModeler)	Sets whether this parameter can be input from the modeler.
void	setMultiple(boolean multiple)	Sets whether the parameters created from this schema can contain multiple values.
void	setName(String name)	Sets the name (key).
void	setRequired(boolean required)	Sets whether the message property is required.
void	setType(Long type)	Sets the data type.
void	setVisibleOnReceiveMessage(boolean visibleOnReceiveMessage)	Sets the message property is visible on the ReceiveMessage Node in modeler.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MessagePropertySchema

public MessagePropertySchema()

Method Details

getName

public String getName()

Gets the name (key).

Returns:

the name

See Also:

• setName(String)

setName

public void setName(String name)

Sets the name (key).

Parameters:

name - the name

See Also:

• getName()

isInputFromModeler

public boolean isInputFromModeler()

Gets whether this parameter can be input from the Modeler (whether it shows up in the Message Properties Grid on the Data tab of the Send Messages dialog).

Returns:

whether the parameter can be input from the Modeler

See Also:

• setName(String)

setInputFromModeler

public void setInputFromModeler(boolean inputFromModeler)

Sets whether this parameter can be input from the modeler.

Parameters:

inputFromModeler - whether this parameter can be input from the Modeler

See Also:

• isInputFromModeler()

isMultiple

public boolean isMultiple()

Gets whether the parameters created from this schema can contain multiple values.

Returns:

whether parameters created from this schema can contain multiple values

See Also:

• setMultiple(boolean)

setMultiple

public void setMultiple(boolean multiple)

Sets whether the parameters created from this schema can contain multiple values.

Parameters:

multiple - whether parameters created from this schema can contain multiple values

See Also:

• isMultiple()

isRequired

public boolean isRequired()

Gets whether the message property is required.

Returns:

whether the message property is required

See Also:

• setRequired(boolean)

setRequired

public void setRequired(boolean required)

Sets whether the message property is required.

Parameters:

required - whether the message property is required

See Also:

• isRequired()

getType

public Long getType()

Gets the data type.

Returns:

the data type

See Also:

• setType(Long)

setType

public void setType(Long type)

Sets the data type.

Parameters:

type - the data type

See Also:

• getType()

isVisibleOnReceiveMessage

public boolean isVisibleOnReceiveMessage()

Returns whether the message property is visible on the Receive Message Node in modeler.

Returns:

whether the message property should be displayed.

See Also:

• setVisibleOnReceiveMessage(boolean)

setVisibleOnReceiveMessage

public void setVisibleOnReceiveMessage(boolean visibleOnReceiveMessage)

Sets the message property is visible on the ReceiveMessage Node in modeler.

Parameters:

visibleOnReceiveMessage - whether the message property is visible.

See Also:

• isVisibleOnReceiveMessage()