com.appian.connectedsystems.templateframework.sdk.configuration

Enum RefreshPolicy

Object

Enum<RefreshPolicy>

com.appian.connectedsystems.templateframework.sdk.configuration.RefreshPolicy

All Implemented Interfaces:

Serializable, Comparable<RefreshPolicy>

public enum RefreshPolicy
extends Enum<RefreshPolicy>

Determines whether IntegrationTemplate.getConfigurationDescriptor(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath, com.appian.connectedsystems.templateframework.sdk.ExecutionContext) or ConnectedSystemTemplate.getConfigurationDescriptor(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath, com.appian.connectedsystems.templateframework.sdk.ExecutionContext) will be called when the user updates a given property.

Use PropertyDescriptorBuilder.refresh(RefreshPolicy) to set this value

For fields that do not affect the UI, use NEVER. For fields that should result in dynamic UI behavior, use ALWAYS.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALWAYS Whenever a user updates the given property's value, getConfigurationDescriptor will be called.
NEVER Updating the property descriptor will never result in a call to create a new ConfigurationDescriptor; rather, the state will simply be updated with the new value.

Method Summary

Modifier and Type	Method and Description
static RefreshPolicy	valueOf(String name) Returns the enum constant of this type with the specified name.
static RefreshPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEVER

public static final RefreshPolicy NEVER

Updating the property descriptor will never result in a call to create a new ConfigurationDescriptor; rather, the state will simply be updated with the new value.

ALWAYS

public static final RefreshPolicy ALWAYS

Whenever a user updates the given property's value, getConfigurationDescriptor will be called.

Method Detail

values

public static RefreshPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (RefreshPolicy c : RefreshPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RefreshPolicy valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null