com.appian.connectedsystems.simplified.sdk.configuration

Class ConfigurableTemplate

Object

com.appian.connectedsystems.simplified.sdk.configuration.ConfigurableTemplate

Direct Known Subclasses:

SimpleConnectedSystemTemplate, SimpleIntegrationTemplate

public class ConfigurableTemplate
extends Object

Creates fields that are used to accept and store user input, display read-only information to the user, and store additional metadata needed for execution.

All properties should be constructed using the methods found here. Properties constructed outside of the ConfigurableTemplate might have unexpected behavior.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.appian.connectedsystems.simplified.sdk.configuration.TypePropertyFactory	typePropertyFactory

Constructor Summary

Constructors

Constructor and Description
ConfigurableTemplate()

Method Summary

Modifier and Type	Method and Description
BooleanPropertyDescriptor.BooleanPropertyDescriptorBuilder	booleanProperty(String key)
protected PropertyPath	deroot(PropertyPath updatedProperty)
DocumentPropertyDescriptor.DocumentPropertyDescriptorBuilder	documentProperty(String key)
DoublePropertyDescriptor.DoublePropertyDescriptorBuilder	doubleProperty(String key)
TextPropertyDescriptor.TextPropertyDescriptorBuilder	dropdownProperty(String key, List<Choice> choices)
EncryptedTextPropertyDescriptor.EncryptedTextPropertyDescriptorBuilder	encryptedTextProperty(String key)
FolderPropertyDescriptor.FolderPropertyDescriptorBuilder	folderProperty(String key)
IntegerPropertyDescriptor.IntegerPropertyDescriptorBuilder	integerProperty(String key)
ListTypePropertyDescriptor.Builder	listTypeProperty(String key)
LocalTypeDescriptor.Builder	localType(String name) A data structure consisting of a name and a list of PropertyDescriptor.
PropertyDescriptorBuilder	localTypeProperty(LocalTypeDescriptor localType)
PropertyDescriptorBuilder	localTypeProperty(LocalTypeDescriptor localType, String key)
TextPropertyDescriptor.TextPropertyDescriptorBuilder	textProperty(String key)

Methods inherited from class Object

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

Field Detail

typePropertyFactory

protected final com.appian.connectedsystems.simplified.sdk.configuration.TypePropertyFactory typePropertyFactory

Constructor Detail

ConfigurableTemplate

public ConfigurableTemplate()

Method Detail

localType

public LocalTypeDescriptor.Builder localType(String name)

A data structure consisting of a name and a list of PropertyDescriptor. Local type representing a person:

   localType("personType")
     .properties(
       textProperty("name")
         .label("Name")
         .build(),
       integerProperty("height")
         .label("Height")
         .build(),
       booleanProperty("isMinor")
         .label("Is Minor")
         .build())
     .build();
 

Parameters:

name - Name of the type

Returns:

Local type builder with provided name

localTypeProperty

public PropertyDescriptorBuilder localTypeProperty(LocalTypeDescriptor localType)

Parameters:

localType - Data structure composed of properties

Returns:

Local type property builder with the name of the local type as the key

localTypeProperty

public PropertyDescriptorBuilder localTypeProperty(LocalTypeDescriptor localType,
                                                   String key)

Parameters:

localType - Data structure composed of properties

key - Unique identifier to get and set the value of the property in SimpleConfiguration

Returns:

Local type property builder with the provided key

listTypeProperty

public ListTypePropertyDescriptor.Builder listTypeProperty(String key)

Parameters:

key - Unique identifier to get and set the value of the property in SimpleConfiguration

Returns:

List type property builder with the provided key

textProperty

public TextPropertyDescriptor.TextPropertyDescriptorBuilder textProperty(String key)

Parameters:

key - Unique identifier to get and set the value of the property in SimpleConfiguration

Returns:

Text property builder with the provided key

encryptedTextProperty

public EncryptedTextPropertyDescriptor.EncryptedTextPropertyDescriptorBuilder encryptedTextProperty(String key)

Parameters:

key - Unique identifier to get and set the value of the property in SimpleConfiguration

Returns:

Encrypted text property builder with the provided key

booleanProperty

public BooleanPropertyDescriptor.BooleanPropertyDescriptorBuilder booleanProperty(String key)

Parameters:

key - Unique identifier to get and set the value of the property in SimpleConfiguration

Returns:

Boolean property builder with the provided key

integerProperty

public IntegerPropertyDescriptor.IntegerPropertyDescriptorBuilder integerProperty(String key)

Parameters:

key - Unique identifier to get and set the value of the property in SimpleConfiguration

Returns:

Integer property builder with the provided key

doubleProperty

public DoublePropertyDescriptor.DoublePropertyDescriptorBuilder doubleProperty(String key)

Parameters:

key - Unique identifier to get and set the value of the property in SimpleConfiguration

Returns:

Double property builder with the provided key

documentProperty

public DocumentPropertyDescriptor.DocumentPropertyDescriptorBuilder documentProperty(String key)

Parameters:

key - Unique identifier to get and set the value of the property in SimpleConfiguration

Returns:

Document property builder with the provided key

dropdownProperty

public TextPropertyDescriptor.TextPropertyDescriptorBuilder dropdownProperty(String key,
                                                                             List<Choice> choices)

Parameters:

key - Unique identifier to get and set the value of the property in SimpleConfiguration

choices - List of choices to be displayed in the dropdown

Returns:

Text property builder configured as a dropdown with the provided choices

folderProperty

public FolderPropertyDescriptor.FolderPropertyDescriptorBuilder folderProperty(String key)

Parameters:

key - Unique identifier to get and set the value of the property in SimpleConfiguration

Returns:

Folder property builder with the provided key

deroot

protected PropertyPath deroot(PropertyPath updatedProperty)