Index (Appian Connected Systems Core)

A B C D E F G H I K L M N O P R S T U V W

A

addErrorDiagnostic(IntegrationError) - Method in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic.IntegrationDesignerDiagnosticBuilder: Unlike in the IntegrationResponse, developer-provided error messages should be internationalized in the diagnostics.
addErrors(String...) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: Adds a single error to the existing list of errors.
addErrors(Collection<String>) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: Adds a collection of errors to the existing list of errors.
addExecutionTimeDiagnostic(long) - Method in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic.IntegrationDesignerDiagnosticBuilder: Sets how long the external system took to complete the operation
addRequestDiagnostic(Map<String, Object>) - Method in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic.IntegrationDesignerDiagnosticBuilder: Adds a map of keys and values that represent the raw values sent to the external system.
addResponseDiagnostic(Map<String, Object>) - Method in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic.IntegrationDesignerDiagnosticBuilder: Adds a map of keys and values that represent the raw values returned by the external system.
addSegment(Object) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath: Appends the provided segment to the end of the path
authUrl(String) - Method in class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData.Builder

B

BooleanDisplayMode - Enum in com.appian.connectedsystems.templateframework.sdk.configuration: Determines how to render the boolean property in the UI
BooleanPropertyDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration: A boolean property.
BooleanPropertyDescriptor(BooleanPropertyDescriptor.BooleanPropertyDescriptorBuilder) - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.BooleanPropertyDescriptor
BooleanPropertyDescriptor.BooleanPropertyDescriptorBuilder - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Builder for the boolean property descriptor
BooleanPropertyDescriptorBuilder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.BooleanPropertyDescriptor.BooleanPropertyDescriptorBuilder
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.BooleanPropertyDescriptor.BooleanPropertyDescriptorBuilder: Builds the property descriptor.
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Choice.ChoiceBuilder: Constructs the choice
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor.ConfigurationDescriptorBuilder: Constructs the built configuration descriptor
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.DocumentPropertyDescriptor.DocumentPropertyDescriptorBuilder: Constructs the built property descriptor.
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.DoublePropertyDescriptor.DoublePropertyDescriptorBuilder
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.EncryptedTextPropertyDescriptor.EncryptedTextPropertyDescriptorBuilder: Builds the property descriptor.
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.FolderPropertyDescriptor.FolderPropertyDescriptorBuilder: Constructs the built property descriptor.
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.IntegerPropertyDescriptor.IntegerPropertyDescriptorBuilder: Builds the property descriptor.
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypeDescriptor.Builder
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypePropertyDescriptor.Builder
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor.Builder: Constructs the local type
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypePropertyDescriptor.LocalTypePropertyDescriptorBuilder: Constructs the built property descriptor
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Constructs the built property descriptor.
build() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor.TextPropertyDescriptorBuilder: Builds the property descriptor.
build() - Method in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic.IntegrationDesignerDiagnosticBuilder: Constructs the built diagnostics
build() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationError.IntegrationErrorBuilder: Constructs the built integration error
build() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse.Builder: Constructs the built integration response
build() - Method in class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData.Builder
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.BooleanPropertyDescriptor: Builder for the boolean property descriptor
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.Choice: Builder for the choice
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor: Builder for a configuration descriptor
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.DocumentPropertyDescriptor: Builder for document property descriptor.
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.DoublePropertyDescriptor: Builder for the double property descriptor
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.EncryptedTextPropertyDescriptor: Builder for the encrypted text property descriptor
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.FolderPropertyDescriptor: Builder for folder property descriptor.
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.IntegerPropertyDescriptor: Builder for the integer property descriptor
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypeDescriptor
Builder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypeDescriptor.Builder
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypePropertyDescriptor: ListTypePropertyDescriptor is only supported for Integration Templates
Builder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypePropertyDescriptor.Builder
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor: Builder for the LocalTypeDescriptor class
Builder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor.Builder
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypePropertyDescriptor: Builder for the local type property descriptor
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor: Builder for the text property descriptor
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic: Builder for the diagnostics
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.IntegrationError: Builder for integration error
Builder(IntegrationResponse) - Constructor for class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse.Builder
builder() - Static method in class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData
Builder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData.Builder

C

checkValidState() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.DocumentPropertyDescriptor.DocumentPropertyDescriptorBuilder
checkValidState() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.FolderPropertyDescriptor.FolderPropertyDescriptorBuilder
checkValidState() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypePropertyDescriptor.LocalTypePropertyDescriptorBuilder
checkValidState() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder
Choice - Class in com.appian.connectedsystems.templateframework.sdk.configuration: A dropdown choice to display to the designer during configuration Use when constructing PropertyDescriptorBuilder.choices
choice(Choice) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor.TextPropertyDescriptorBuilder: Adds a single choice option.
Choice.ChoiceBuilder - Class in com.appian.connectedsystems.templateframework.sdk.configuration
ChoiceBuilder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.Choice.ChoiceBuilder
CHOICES - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
choices - Variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder
choices(Choice...) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor.TextPropertyDescriptorBuilder: Adds a series of choice options.
clearErrors() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: Clears all errors for this property state.
clearErrorsAtPath(PropertyPath) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: Clears all errors for the property state at the given path.
clearProperties() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor.Builder: Removes all properties
clearProperties() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor: Removes all properties
ClientApi - Interface in com.appian.connectedsystems.templateframework.sdk: A ClientApi enhances Component Plugins with the capability to execute code on the server with access to secured values Each Client API must be associated with exactly one ConnectedSystemTemplate via the TemplateId annotation.
ClientApiRequest - Interface in com.appian.connectedsystems.templateframework.sdk: Representation of a request from a Component Plugin coupled with data from the associated Connected System object.
ClientApiResponse - Class in com.appian.connectedsystems.templateframework.sdk: The result of a ClientApi execution which is serialized and sent to the client.
ClientApiResponse(Map<String, Object>) - Constructor for class com.appian.connectedsystems.templateframework.sdk.ClientApiResponse: Constructs a response
clientId(String) - Method in class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData.Builder
clientSecret(String) - Method in class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData.Builder
com.appian.connectedsystems.templateframework.sdk - package com.appian.connectedsystems.templateframework.sdk
com.appian.connectedsystems.templateframework.sdk.configuration - package com.appian.connectedsystems.templateframework.sdk.configuration
com.appian.connectedsystems.templateframework.sdk.connectiontesting - package com.appian.connectedsystems.templateframework.sdk.connectiontesting
com.appian.connectedsystems.templateframework.sdk.diagnostics - package com.appian.connectedsystems.templateframework.sdk.diagnostics
com.appian.connectedsystems.templateframework.sdk.metadata - package com.appian.connectedsystems.templateframework.sdk.metadata
com.appian.connectedsystems.templateframework.sdk.oauth - package com.appian.connectedsystems.templateframework.sdk.oauth
com.appian.connectedsystems.templateframework.sdk.services - package com.appian.connectedsystems.templateframework.sdk.services
com.appian.connectedsystems.templateframework.sdk.services.exceptions - package com.appian.connectedsystems.templateframework.sdk.services.exceptions
ConfigurationDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration: A data structure that describes an instance of an IntegrationTemplate or ConnectedSystemTemplate.
ConfigurationDescriptor.ConfigurationDescriptorBuilder - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Builder for a configuration descriptor
ConnectedSystemTemplate - Interface in com.appian.connectedsystems.templateframework.sdk: Each implementation of ConnectedSystemTemplate represents a new type of connected system available to designers in Appian.
create(int) - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.Expression: Create a new expression object with a given id.

D

data - Variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
data - Variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder
DESCRIPTION - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
description(String) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Sets text to display in a help icon as a tooltip.
detail(String) - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationError.IntegrationErrorBuilder: The error detail.
DISPLAY_HINT - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
DISPLAY_MODE - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.BooleanPropertyDescriptor
DisplayHint - Enum in com.appian.connectedsystems.templateframework.sdk.configuration: Alters the display of a property in the UI
displayHint(DisplayHint) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Determines whether the UI component appears as a standard input field.
displayMode(BooleanDisplayMode) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.BooleanPropertyDescriptor.BooleanPropertyDescriptorBuilder: Sets the display mode.
Document - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Data structure representing a document stored in Appian.
Document(Integer, InputStream, String, String, Integer, Long) - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.Document: Document objects will be passed on IntegrationTemplate.execute(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.ExecutionContext) and 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) in the ConfigurationDescriptor.
Document(Integer) - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.Document: Document objects will be passed on IntegrationTemplate.execute(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.ExecutionContext) and 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) in the ConfigurationDescriptor.
DocumentDownloadException - Exception in com.appian.connectedsystems.templateframework.sdk.services.exceptions: An exception thrown during download.
DocumentDownloadException(Exception, String, Long) - Constructor for exception com.appian.connectedsystems.templateframework.sdk.services.exceptions.DocumentDownloadException
DocumentDownloadService - Interface in com.appian.connectedsystems.templateframework.sdk.services: Injected service used to story binary files pulled from external systems.
DocumentPropertyDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration: A document property.
DocumentPropertyDescriptor.DocumentPropertyDescriptorBuilder - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Builder for document property descriptor.
DoublePropertyDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration: A double property State Value: Double
DoublePropertyDescriptor.DoublePropertyDescriptorBuilder - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Builder for the double property descriptor
DoublePropertyDescriptorBuilder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.DoublePropertyDescriptor.DoublePropertyDescriptorBuilder: Builds the property descriptor.
downloadDocument(InputStream, Long, String) - Method in interface com.appian.connectedsystems.templateframework.sdk.services.DocumentDownloadService: Downloads data from provided stream and stores as a file.

E

emptyDocument() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.Document: Singleton document representing a null document
emptyExpression() - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.Expression
EncryptedTextPropertyDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration: An encrypted text property.
EncryptedTextPropertyDescriptor.EncryptedTextPropertyDescriptorBuilder - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Builder for the encrypted text property descriptor
EncryptedTextPropertyDescriptorBuilder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.EncryptedTextPropertyDescriptor.EncryptedTextPropertyDescriptorBuilder
equals(Object) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Choice
equals(Object) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath
equals(Object) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState
equals(Object) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference
equals(SystemType) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference
equals(Object) - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationError
error(String) - Static method in class com.appian.connectedsystems.templateframework.sdk.connectiontesting.TestConnectionResult: Return in TestableConnectedSystemTemplate.testConnection(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.ExecutionContext) when credentials are invalid
error(List<String>) - Static method in class com.appian.connectedsystems.templateframework.sdk.connectiontesting.TestConnectionResult: Return in TestableConnectedSystemTemplate.testConnection(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.ExecutionContext) when credentials are invalid
error - Variable in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse.Builder
ERROR_DETAIL - Static variable in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic
ERROR_KEY - Static variable in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic
ERROR_MESSAGE - Static variable in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic
ERROR_TITLE - Static variable in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic
ERRORS_KEY - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState
execute(ClientApiRequest, ExecutionContext) - Method in interface com.appian.connectedsystems.templateframework.sdk.ClientApi: Defines the behavior of the Client API.
execute(ConfigurationDescriptor, ConfigurationDescriptor, ExecutionContext) - Method in interface com.appian.connectedsystems.templateframework.sdk.IntegrationTemplate: Returns an IntegrationResponse.
ExecutionContext - Interface in com.appian.connectedsystems.templateframework.sdk: Injected context that may be necessary to create or recreate a Configuration or execute an Integration.
ExpiredTokenException - Exception in com.appian.connectedsystems.templateframework.sdk.oauth: An exception to throw when the token provided by ExecutionContext.getAccessToken() is invalid.
ExpiredTokenException() - Constructor for exception com.appian.connectedsystems.templateframework.sdk.oauth.ExpiredTokenException
Expression - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Token representing a SAIL expression in the state on IntegrationTemplate.getConfigurationDescriptor(ConfigurationDescriptor, ConfigurationDescriptor, PropertyPath, ExecutionContext) To create or clear an expression set the value in the state to Expression.emptyExpression()

F

FolderPropertyDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration: A folder property.
FolderPropertyDescriptor(FolderPropertyDescriptor.FolderPropertyDescriptorBuilder) - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.FolderPropertyDescriptor
FolderPropertyDescriptor.FolderPropertyDescriptorBuilder - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Builder for folder property descriptor.
FolderPropertyDescriptorBuilder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.FolderPropertyDescriptor.FolderPropertyDescriptorBuilder
forEach(Consumer<? super Object>) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath
forError(IntegrationError) - Static method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse: A builder with success set to false Diagnostics should still be added if ExecutionContext.isDiagnosticsEnabled()
forSuccess(Map<String, Object>) - Static method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse: A builder with success set to true Diagnostics should still be added if ExecutionContext.isDiagnosticsEnabled()
from(LocalTypeDescriptor) - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor.Builder: Constructs a builder from a local type descriptor
from(SystemType) - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference: Constructs a TypeReference from a SystemType
from(LocalTypeDescriptor) - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference: Constructs a TypeReference from a LocalTypeDescriptor
from(ListTypeDescriptor) - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference: Constructs a TypeReference from a ListTypeDescriptor

G

generateDefaultState(TypeReference) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.StateGenerator: Generates a default PropertyState for the provided type.
generateDefaultState(LocalTypeDescriptor) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.StateGenerator: Convenience method for StateGenerator.generateDefaultState(TypeReference)
generateDefaultValue(TypeReference, int) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.StateGenerator
generateFromExistingState(LocalTypeDescriptor, PropertyState, PropertyPath) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.StateGenerator: Convenience method for StateGenerator.generateFromExistingState(LocalTypeDescriptor, PropertyState).
generateFromExistingState(LocalTypeDescriptor, PropertyState) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.StateGenerator: Maps properties from the provided state to a new PropertyState with the given type.
getAccessToken() - Method in interface com.appian.connectedsystems.templateframework.sdk.ExecutionContext: OAuth access token for the current user.
getAttemptNumber() - Method in interface com.appian.connectedsystems.templateframework.sdk.ExecutionContext: The number of attempts to call execute an Integration or retrieve a Configuration.
getAuthUrl() - Method in class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData
getBuilder() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.BooleanPropertyDescriptor
getBuilder() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.DocumentPropertyDescriptor
getBuilder() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.DoublePropertyDescriptor
getBuilder() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.EncryptedTextPropertyDescriptor
getBuilder() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.FolderPropertyDescriptor
getBuilder() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.IntegerPropertyDescriptor
getBuilder() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypePropertyDescriptor
getBuilder() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypePropertyDescriptor
getBuilder() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
getBuilder() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor
getChoices() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor: If choices are provided, the property appears as a dropdown to the user.
getClientId() - Method in class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData
getClientSecret() - Method in class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData
getConfigurationDescriptor(ConfigurationDescriptor, PropertyPath, ExecutionContext) - Method in interface com.appian.connectedsystems.templateframework.sdk.ConnectedSystemTemplate: Returns the configuration that defines the UI and data stored for a Connected System object.
getConfigurationDescriptor(ConfigurationDescriptor, ConfigurationDescriptor, PropertyPath, ExecutionContext) - Method in interface com.appian.connectedsystems.templateframework.sdk.IntegrationTemplate: Returns a configuration for the given Integration object.
getConnectedSystemConfigDescriptor() - Method in interface com.appian.connectedsystems.templateframework.sdk.ClientApiRequest: The configuration of the connected system associated with the Client API.
getData() - Method in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic: The diagnostics data represented as a Map
getDefault() - Method in enum com.appian.connectedsystems.templateframework.sdk.configuration.SystemType
getDescription() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Text displayed as a tooltip.
getDesignerLocale() - Method in interface com.appian.connectedsystems.templateframework.sdk.ExecutionContext: The locale of the user configuring the integration.
getDetail() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationError: The error detail.
getDisplayHint() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Default: DisplayHint.NORMAL Whether UI component is displayed as an expression box or a standard input field
getDisplayMode() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.BooleanPropertyDescriptor: The property's display mode.
getDocumentDownloadService() - Method in interface com.appian.connectedsystems.templateframework.sdk.ExecutionContext: Returns a DocumentDownloadService.
getError() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse.Builder: Returns the error
getError() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse: The error that occurred during the call, if an error occurred
getErrors() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: Errors related to this property state.
getErrorsAtPath(PropertyPath) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: The property state's errors at a given PropertyPath.
getExcludedHosts() - Method in interface com.appian.connectedsystems.templateframework.sdk.ProxyConfigurationData: A list of excluded hosts.
getExecutionLocale() - Method in interface com.appian.connectedsystems.templateframework.sdk.ExecutionContext: The locale to use when creating an IntegrationError.
getExtension() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Document: The document's extension
getFileName() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Document: The documents name and extension
getFilename() - Method in exception com.appian.connectedsystems.templateframework.sdk.services.exceptions.DocumentDownloadException: The name of the file that failed to save
getFileSize() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Document: The document's size, in bytes
getFolderId() - Method in exception com.appian.connectedsystems.templateframework.sdk.services.exceptions.DocumentDownloadException: The folder to which the file was being saved
getGenericTypeArguments() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference: Retrieves all type references for generic types.
getHost() - Method in interface com.appian.connectedsystems.templateframework.sdk.ProxyConfigurationData: The proxy's host
getId() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Document
getId() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Expression
getInputStream() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Document: A stream of the document's content.
getInstructionText() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Text displayed below the field's value
getIntegrationDesignerDiagnostic() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse: Diagnostics for the execution
getIntegrationErrorBulletList() - Method in class com.appian.connectedsystems.templateframework.sdk.connectiontesting.TestConnectionResult: A list of error messages describing the failures to validate the provided credentials with the external system This is set using TestConnectionResult.error(List)
getIntegrationErrorMessage() - Method in class com.appian.connectedsystems.templateframework.sdk.connectiontesting.TestConnectionResult: A single error message describing the failure to validate the provided credentials with the external system.
getKey() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Unique identifier for this property.
getLabel() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Text to display as the field label
getListItemType() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypeDescriptor
getListItemType() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference: Returns the type of a list's items
getMessage() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationError: The error message.
getName() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Choice: The text displayed to the user for this choice
getName() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeDescriptor: The name of the type
getOAuthConfiguration(ConfigurationDescriptor) - Method in interface com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConnectedSystemTemplate: Given user entered data, returns information needed to authorize using OAuth 2.0 authorization code grant Given the user entered information contained in the ConfigurationDescriptor, returns an OAuthConfigurationData object that contains the information needed to prompt the user to authorize
getParentFolderId() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Document
getPassword() - Method in interface com.appian.connectedsystems.templateframework.sdk.ProxyConfigurationData: If the proxy is authenticated, returns the password for the proxy
getPayload() - Method in interface com.appian.connectedsystems.templateframework.sdk.ClientApiRequest: the payload sent by the Component Plugin.
getPlaceholder() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Text to display in the component when it is empty.
getPort() - Method in interface com.appian.connectedsystems.templateframework.sdk.ProxyConfigurationData: The proxy's port
getProperties() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor: The list of properties that compose the local type.
getProperty(String) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor: Gets a property by its key
getPropertyKeys() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor: Keys of the PropertyDescriptors
getPropertyStateAtPath(PropertyPath) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: The property state at a given path.
getProxyConfigurationData() - Method in interface com.appian.connectedsystems.templateframework.sdk.ExecutionContext: Proxy configurations for the site.
getRefresh() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Default: RefreshPolicy.NEVER Determines when changes to the UI component will trigger refresh
getResult() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse.Builder: Returns the result
getResult() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse: The information retrieved from the external system that is relevant to the user
getResultMap() - Method in class com.appian.connectedsystems.templateframework.sdk.ClientApiResponse
getRootState() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor: The combination of user input and developer configuration data that defines an instance of a ConnectedSystemTemplate or IntegrationTemplate.
getScope() - Method in class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData
getState() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor: Use ConfigurationDescriptor.getRootState()
getStateKeysToMaintain(LocalTypeDescriptor, Map<String, Object>) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.StateGenerator
getTitle() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationError: The error title.
getTokenUrl() - Method in class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData
getType() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: The property state's type
getTypeAtPath(PropertyPath) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: /** The property state's type at a given PropertyPath.
getTypeDisplayName() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference
getTypeRef() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
getTypes() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor: The structure of and rendering configurations for the data that define a ConnectedSystemTemplate or IntegrationTemplate instance.
getUnqualifiedTypeName() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference: The unqualified type name.
getUsername() - Method in interface com.appian.connectedsystems.templateframework.sdk.ProxyConfigurationData: If the proxy is authenticated, returns the username for the proxy
getValue() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Choice: The value associated with this choice.
getValue() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: The property state's value
getValueAtPath(PropertyPath) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: The property state's value at a given PropertyPath.

H

HAS_TRANSIENT_CHOICES - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor
hasAccessToConnectedSystem() - Method in interface com.appian.connectedsystems.templateframework.sdk.ExecutionContext: Whether the user has access to the connected system.
hashCode() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Choice
hashCode() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath
hashCode() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState
hashCode() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference
hashCode() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationError
hasTransientChoices() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor: If the field is marked as transient the available choices options would be removed when the object is saved.

I

INSTRUCTION_TEXT - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
instructionText(String) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Sets optional text displayed below the component's value.
IntegerPropertyDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration: An integer property State Value: Integer
IntegerPropertyDescriptor.IntegerPropertyDescriptorBuilder - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Builder for the integer property descriptor
IntegerPropertyDescriptorBuilder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.IntegerPropertyDescriptor.IntegerPropertyDescriptorBuilder
IntegrationDesignerDiagnostic - Class in com.appian.connectedsystems.templateframework.sdk.diagnostics: Diagnostics for users to debug failed calls or unexpected results during IntegrationTemplate.execute(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.ExecutionContext).
integrationDesignerDiagnostic - Variable in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse.Builder
IntegrationDesignerDiagnostic.IntegrationDesignerDiagnosticBuilder - Class in com.appian.connectedsystems.templateframework.sdk.diagnostics: Builder for the diagnostics
IntegrationError - Class in com.appian.connectedsystems.templateframework.sdk: Information why an integration execution failed.
IntegrationError.IntegrationErrorBuilder - Class in com.appian.connectedsystems.templateframework.sdk
IntegrationErrorBuilder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.IntegrationError.IntegrationErrorBuilder
IntegrationResponse - Class in com.appian.connectedsystems.templateframework.sdk: The result of an operation in an external system .
IntegrationResponse.Builder - Class in com.appian.connectedsystems.templateframework.sdk: Builder for the integration response
IntegrationTemplate - Interface in com.appian.connectedsystems.templateframework.sdk: Represents an Integration Type in Appian.
IntegrationTemplateRequestPolicy - Enum in com.appian.connectedsystems.templateframework.sdk.metadata: Indicates whether executing the IntegrationTemplate will result in updates to the external system.
IntegrationTemplateType - Annotation Type in com.appian.connectedsystems.templateframework.sdk.metadata: Indicates whether executing the IntegrationTemplate will result in updates to the external system.
IS_EXPRESSIONABLE - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
IS_HIDDEN - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
IS_IMPORT_CUSTOMIZABLE - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
IS_MASKED - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.EncryptedTextPropertyDescriptor
IS_MASKED - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor
IS_READ_ONLY - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
IS_REQUIRED - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
isAuthRequired() - Method in interface com.appian.connectedsystems.templateframework.sdk.ProxyConfigurationData: Whether the proxy requires authentication
isDiagnosticsEnabled() - Method in interface com.appian.connectedsystems.templateframework.sdk.ExecutionContext: Whether diagnostics should be provided.
isEmpty() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Expression
isEnabled() - Method in interface com.appian.connectedsystems.templateframework.sdk.ProxyConfigurationData: Whether a proxy is enabled
isExcludedHost(String) - Method in interface com.appian.connectedsystems.templateframework.sdk.ProxyConfigurationData: true if the provided url should NOT be proxied, otherwise false
isExpression() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: Whether the property state's type is SystemType.EXPRESSION
isExpressionable() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Default: false Whether the field can be entered as an expression If dynamic behavior will be defined by the designer set this to true To make the property always appear as an expression box, use the display hint.
isExpressionable(boolean) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Determines if field can be entered as an expression.
isHidden() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Default: false Whether the field is displayed in the UI.
isHidden(boolean) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Determines whether the field is displayed in the UI.
isImportCustomizable() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Default: false Whether this value should be changed between environments.
isImportCustomizable(boolean) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Determines whether this value should be changed between environments.
isListType() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference: Whether the type points to a ListTypeDescriptor
isLocalType() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference: Whether the type points to a LocalTypeDescriptor
isMasked() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.EncryptedTextPropertyDescriptor: Determines whether the property's value will be masked in the UI.
isMasked() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor: Whether the property's value will be masked in the UI.
isReadOnly() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Default: false Determines whether the property's value is editable by the user.
isReadOnly(boolean) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Determines whether the property's value is editable by the user.
isRequired() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Default: false Whether the field is required
isRequired(boolean) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Determines whether a non-null value is required to submit the form.
isSuccess() - Method in class com.appian.connectedsystems.templateframework.sdk.connectiontesting.TestConnectionResult: Whether the test was successful
isSuccess() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse.Builder: Returns the success status
isSuccess() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse: Whether the execution was successful
isSystemType() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference: Whether the type points to a SystemType
itemType(TypeReference) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypePropertyDescriptor.Builder
itemType(SystemType) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypePropertyDescriptor.Builder
iterator() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath

K

KEY - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
key(String) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Sets the unique identifier for this property.

L

LABEL - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
label(String) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Sets optional text to display at the top of this component.
LIST_TYPE_NAME - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypeDescriptor
LIST_TYPE_NAME - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypePropertyDescriptor
listOfChoices(List<Map>) - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.Choice: Create a List of Choice given a Map<String,Object>
ListTypeDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration
ListTypeDescriptor.Builder - Class in com.appian.connectedsystems.templateframework.sdk.configuration
ListTypePropertyDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration
ListTypePropertyDescriptor.Builder - Class in com.appian.connectedsystems.templateframework.sdk.configuration
LocalTypeDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration: A complex data structure composed of property descriptors.
LocalTypeDescriptor.Builder - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Builder for the LocalTypeDescriptor class
LocalTypePropertyDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration: A complex property containing a reference to another LocalTypeDescriptor.
LocalTypePropertyDescriptor.LocalTypePropertyDescriptorBuilder - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Builder for the local type property descriptor
LocalTypePropertyDescriptorBuilder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypePropertyDescriptor.LocalTypePropertyDescriptorBuilder

M

masked(boolean) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.EncryptedTextPropertyDescriptor.EncryptedTextPropertyDescriptorBuilder: Sets the property as masked or unmasked in the UI.
masked(boolean) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor.TextPropertyDescriptorBuilder: Sets whether the property's value will be masked in the UI.
message(String) - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationError.IntegrationErrorBuilder: The error message.

N

name(String) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Choice.ChoiceBuilder: The text displayed to the user for this choice
NAME - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.Choice
name(String) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor.Builder
NAME - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor

O

OAuthConfigurationData - Class in com.appian.connectedsystems.templateframework.sdk.oauth
OAuthConfigurationData.Builder - Class in com.appian.connectedsystems.templateframework.sdk.oauth
OAuthConnectedSystemTemplate - Interface in com.appian.connectedsystems.templateframework.sdk.oauth: ConnectedSystemTemplate that uses the Authorization Code Grant type Connected System Types that implement OAuthConnectedSystemTemplate can be authorized from the UI by a user.
ofType(TypeReference) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypeDescriptor.Builder
ofType(SystemType) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ListTypeDescriptor.Builder

P

parse(String) - Static method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference: Constructs a TypeReference from the String representation of a type reference.
PLACEHOLDER - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
placeholder(String) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Sets optional text to display in the component when it is empty.
properties(PropertyDescriptor...) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor.Builder: Adds the supplied properties to the local type's list of properties.
properties(Collection<PropertyDescriptor>) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor.Builder: Adds the supplied properties to the local type's list of properties.
PROPERTIES - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor
property(PropertyDescriptor) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor.Builder: Adds the supplied property to the local type's list of properties.
PropertyDescriptor<T extends PropertyDescriptorBuilder> - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Properties are used to accept and store user input, display read-only information to the user, and store additional metadata needed for execution.
PropertyDescriptorBuilder<TBuilder extends PropertyDescriptorBuilder<TBuilder>> - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Base class for property descriptor builders.
PropertyDescriptorBuilder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder
PropertyPath - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Path in property keys or list indices from one PropertyState to another.
PropertyPath(Object...) - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath: Constructs a path of the provided segments
PropertyPath(List<Object>) - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath: Constructs a path of the provided segments
PropertyState - Class in com.appian.connectedsystems.templateframework.sdk.configuration: The state for a single property in a ConfigurationDescriptor.
ProxyConfigurationData - Interface in com.appian.connectedsystems.templateframework.sdk: Proxy configurations for the site.

R

REFRESH - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
refresh(RefreshPolicy) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder: Determines whether changes to this property's UI component will refresh the configuration descriptor.
RefreshPolicy - Enum in com.appian.connectedsystems.templateframework.sdk.configuration: 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.
removeProperties(Predicate<PropertyDescriptor>) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor: Removes all properties that meet the supplied condition For Example: myType.removeProperties(p -> "PROP_TO_REMOVE".equals(p.getKey()))
REQUEST_KEY - Static variable in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic
RESPONSE_KEY - Static variable in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic
result - Variable in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse.Builder
ROOT_KEY - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor

S

scope(String) - Method in class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData.Builder
SEND_WAIT_RECEIVE - Static variable in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic
setError(String) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: Clears all existing errors and adds the provided error to the empty list of errors.
setErrorAtPath(PropertyPath, String) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: Clears all existing errors, replacing them with the given error.
setErrors(Collection<String>) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: Clears all existing errors and adds the provided errors to the empty list of errors.
setErrorsAtPath(PropertyPath, List<String>) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: Clears all existing errors, replacing them with the given errors.
setType(TypeReference) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: The property state's type
setType(SystemType) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: The property state's type
setType(LocalTypeDescriptor) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: The property state's type
setValue(Object) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: The property state's value
setValueAtPath(PropertyPath, Object) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState: The property state's value at a given path.
spliterator() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath
STATE_KEY - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor
StateGenerator - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Generates PropertyState objects given types and pre-existing state.
StateGenerator(LocalTypeDescriptor...) - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.StateGenerator: Creates a state generator that can create state for the provided local types.
StateGenerator(Collection<LocalTypeDescriptor>) - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.StateGenerator: Creates a state generator that can create state for the provided local types.
success() - Static method in class com.appian.connectedsystems.templateframework.sdk.connectiontesting.TestConnectionResult: Return in TestableConnectedSystemTemplate.testConnection(com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor, com.appian.connectedsystems.templateframework.sdk.ExecutionContext) when credentials are valid
success - Variable in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse.Builder
SystemType - Enum in com.appian.connectedsystems.templateframework.sdk.configuration: Out-of-the-box types for PropertyState

T

TemplateId - Annotation Type in com.appian.connectedsystems.templateframework.sdk: Required unique identifier for this template Required: Name Default: majorVersion = 1 majorVersion() only applies to ConnectedSystemTemplate.
TestableConnectedSystemTemplate - Interface in com.appian.connectedsystems.templateframework.sdk.connectiontesting: ConnectedSystemTemplate that contains credentials that can be validated against an external system.
testConnection(ConfigurationDescriptor, ExecutionContext) - Method in interface com.appian.connectedsystems.templateframework.sdk.connectiontesting.TestableConnectedSystemTemplate: Validates credentials in the connected system Called when user tests the credentials of a Testable Connected System
TestConnectionResult - Class in com.appian.connectedsystems.templateframework.sdk.connectiontesting: A container for the results of TestableConnectedSystemTemplate.testConnection(ConfigurationDescriptor, ExecutionContext)
TextPropertyDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration: A text property.
TextPropertyDescriptor.TextPropertyDescriptorBuilder - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Builder for the text property descriptor
TextPropertyDescriptorBuilder() - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor.TextPropertyDescriptorBuilder
TIMINGS_KEY - Static variable in class com.appian.connectedsystems.templateframework.sdk.diagnostics.IntegrationDesignerDiagnostic
title(String) - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationError.IntegrationErrorBuilder: The error title.
toBuilder() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor: Converts the immutable configuration descriptor to a mutable builder.
toBuilder() - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse: Converts response to a builder, preserving field values
toError(IntegrationError) - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse.Builder: Clears the result and replaces the error with the given value
tokenUrl(String) - Method in class com.appian.connectedsystems.templateframework.sdk.oauth.OAuthConfigurationData.Builder
toString() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
toString() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyPath
toString() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference
toSuccess(Map<String, Object>) - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse.Builder: Clears the error and replaces the result with the given value
toSystemType() - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference: If the value is a SystemType, constructs a SystemType from the TypeReference.
transientChoices(boolean) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.TextPropertyDescriptor.TextPropertyDescriptorBuilder: Signals that this property should remove the Choices options when the object is saved.
type(LocalTypeDescriptor) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypePropertyDescriptor.LocalTypePropertyDescriptorBuilder: Sets the type of the property descriptor
type(TypeReference) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder
type(SystemType) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptorBuilder
TYPE_KEY - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState
TYPE_NAME - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor
TYPE_REF_STEM - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.TypeReference
TypeDescriptor - Class in com.appian.connectedsystems.templateframework.sdk.configuration: Base class for developer created types: ListTypeDescriptor and LocalTypeDescriptor
TypeDescriptor(String) - Constructor for class com.appian.connectedsystems.templateframework.sdk.configuration.TypeDescriptor
TypeReference - Class in com.appian.connectedsystems.templateframework.sdk.configuration: The type of PropertyState.
TYPES_KEY - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor

U

update(Function<T, T>) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyDescriptor: Updates individual fields of the property descriptor
updateProperties(UnaryOperator<PropertyDescriptorBuilder>) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor: Iterates through the list of properties, applying the operator to each.
updateProperties(Predicate<PropertyDescriptor>, UnaryOperator<PropertyDescriptorBuilder>) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.LocalTypeDescriptor: Iterates through the list of properties, applying the operator to each property that meets the filter condition.

V

value(String) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.Choice.ChoiceBuilder: Sets the value to the provided String
VALUE - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.Choice
VALUE_KEY - Static variable in class com.appian.connectedsystems.templateframework.sdk.configuration.PropertyState
valueOf(String) - Static method in enum com.appian.connectedsystems.templateframework.sdk.configuration.BooleanDisplayMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.appian.connectedsystems.templateframework.sdk.configuration.DisplayHint: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.appian.connectedsystems.templateframework.sdk.configuration.RefreshPolicy: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.appian.connectedsystems.templateframework.sdk.configuration.SystemType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.appian.connectedsystems.templateframework.sdk.metadata.IntegrationTemplateRequestPolicy: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.appian.connectedsystems.templateframework.sdk.configuration.BooleanDisplayMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.appian.connectedsystems.templateframework.sdk.configuration.DisplayHint: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.appian.connectedsystems.templateframework.sdk.configuration.RefreshPolicy: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.appian.connectedsystems.templateframework.sdk.configuration.SystemType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.appian.connectedsystems.templateframework.sdk.metadata.IntegrationTemplateRequestPolicy: Returns an array containing the constants of this enum type, in the order they are declared.

W

withDiagnostic(IntegrationDesignerDiagnostic) - Method in class com.appian.connectedsystems.templateframework.sdk.IntegrationResponse.Builder: A builder with the diagnostics set
withState(PropertyState) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor.ConfigurationDescriptorBuilder: Sets the root state of the ConfigurationDescriptor state map.
withType(LocalTypeDescriptor) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor.ConfigurationDescriptorBuilder: Adds a type to the list of types needed to define the template See also: ConfigurationDescriptor.getTypes()
withTypes(LocalTypeDescriptor...) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor.ConfigurationDescriptorBuilder: Adds all provided types to the list of types needed to define the template See also: ConfigurationDescriptor.getTypes()
withTypes(Collection<LocalTypeDescriptor>) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor.ConfigurationDescriptorBuilder: Adds all provided types to the list of types needed to define the template See also: ConfigurationDescriptor.getTypes()
withTypes(Stream<LocalTypeDescriptor>) - Method in class com.appian.connectedsystems.templateframework.sdk.configuration.ConfigurationDescriptor.ConfigurationDescriptorBuilder: Adds all provided types to the list of types needed to define the template See also: ConfigurationDescriptor.getTypes()

A B C D E F G H I K L M N O P R S T U V W