Index (components-api 25.00.020 API)

A B C D E F G I L M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

ActionResponse<T> - Class in com.elo.flows.api.components: This class represents a response wrapper object which contains the result of an action execution as well as additional information about the execution state
ActionResponse() - Constructor for class com.elo.flows.api.components.ActionResponse
ActionResponse.Builder<T> - Class in com.elo.flows.api.components: This class is used to create an ActionResponse
ActionResponse.State - Enum Class in com.elo.flows.api.components

B

build() - Method in class com.elo.flows.api.components.ActionResponse.Builder: Instantiates an actual ActionResponse containing all data set up in this ActionResponse.Builder instance

C

cancel(Class<T>) - Static method in class com.elo.flows.api.components.ActionResponse: This method is a convenience method to provide a ActionResponse.Builder fully set up to build a returnable ActionResponse that is cancelled
cancel(Class<T>, String) - Static method in class com.elo.flows.api.components.ActionResponse: This method is a convenience method to provide a ActionResponse.Builder fully set up to build a returnable ActionResponse that is cancelled with additional information
CANCELLED - Enum constant in enum class com.elo.flows.api.components.ActionResponse.State
cardinality() - Element in annotation interface com.elo.flows.api.components.annotations.Trigger: The cardinalty of the trigger, specifies if the trigger supports a single or multi execution.
com.elo.flows.api.components - package com.elo.flows.api.components
com.elo.flows.api.components.annotations - package com.elo.flows.api.components.annotations
com.elo.flows.api.components.connection - package com.elo.flows.api.components.connection
component() - Element in annotation interface com.elo.flows.api.components.annotations.ComponentServices: the link to the component, defines the relationship between component and service-grouping.
Component - Annotation Interface in com.elo.flows.api.components.annotations: Annotation used for component declaration
COMPONENT - Static variable in class com.elo.flows.api.components.annotations.StoreContext.Scope
ComponentServices - Annotation Interface in com.elo.flows.api.components.annotations: Annotation used to outsource the services of a component.
Config - Annotation Interface in com.elo.flows.api.components.annotations: This annotation is a marker annotation for config parameters
Connection - Annotation Interface in com.elo.flows.api.components.annotations: A field in a component class marked with this annotation will be injected with a connection instance provided by the corresponding connection provider.
ConnectionProvider - Annotation Interface in com.elo.flows.api.components.annotations: Annotation used to define a class as a connection provider
ConnectionRequired - Annotation Interface in com.elo.flows.api.components.annotations: ConnectionRequired is a marker annotation for methods, which need a provided connection.
Context - Annotation Interface in com.elo.flows.api.components.annotations: This annotation can be used to inject a flows context
Context.Type - Enum Class in com.elo.flows.api.components.annotations
Create - Annotation Interface in com.elo.flows.api.components.connection: A method within a connection provider marked with this annotation will be used as instantiator for new connections.
CredentialInfo - Annotation Interface in com.elo.flows.api.components.connection: This annotation helps to provide additional information about the input type needed in the method annotated with Create.
cronExpression() - Element in annotation interface com.elo.flows.api.components.annotations.Scheduled: A default cron expression used to schedule the marked trigger.

D

description() - Element in annotation interface com.elo.flows.api.components.annotations.Component: The description of the component
description() - Element in annotation interface com.elo.flows.api.components.annotations.Service: The description the service
description() - Element in annotation interface com.elo.flows.api.components.annotations.Trigger: The description the trigger
Destroy - Annotation Interface in com.elo.flows.api.components.connection: A method marked with this annotation will be used to destroy a provided connection if destruction is necessary.
displayName() - Element in annotation interface com.elo.flows.api.components.annotations.Component: The displayName of the component, can be used for translation in the client
displayName() - Element in annotation interface com.elo.flows.api.components.annotations.ComponentServices: The displayName of the service-grouping, can be used for translation in the client
displayName() - Element in annotation interface com.elo.flows.api.components.annotations.Service: The displayName of the service, can be used for translation in the client
displayName() - Element in annotation interface com.elo.flows.api.components.annotations.Trigger: The displayName of the trigger, can be used for translation in the client
DynamicInput<T> - Class in com.elo.flows.api.components: This wrapper class, should be used in combination of the annotation DynamicInputSchema in order to declare a dynamic schema input in an annotated Service method.
DynamicInputSchemaResult - Class in com.elo.flows.api.components: This class declares the result of an annotated InputSchemaProvider method.

E

eloLicense() - Element in annotation interface com.elo.flows.api.components.annotations.License: the elo license-key
Embeddable - Annotation Interface in com.elo.flows.api.components.annotations: An annotation to mark a method as embeddable
endpoint() - Element in annotation interface com.elo.flows.api.components.annotations.WebHook

F

FAILED - Enum constant in enum class com.elo.flows.api.components.ActionResponse.State
form() - Element in annotation interface com.elo.flows.api.components.connection.CredentialInfo: Offers the possibility to customize how the form will be rendered Currently not supported
FormData - Class in com.elo.flows.api.components: Contains the raw form data as well as typed form data for a given lookup call JSONata-Expressions contained in the form data will be mapped to null values in the typed object
FormData(Map<String, Object>, Map<String, Object>, BiFunction<Object, Type, Object>) - Constructor for class com.elo.flows.api.components.FormData: Creates a new instance for the given raw form data and the given typed form data
FormData.FormDataMappingException - Exception Class in com.elo.flows.api.components
FormData.MissingFormDataInputForTypeException - Exception Class in com.elo.flows.api.components

G

get(Class<T>) - Method in class com.elo.flows.api.components.FormData: Returns the typed form data
get(Type) - Method in class com.elo.flows.api.components.FormData: Returns the typed form data
get(String, Type) - Method in class com.elo.flows.api.components.FormData: Returns the typed form data considering the given argument key.
getConfig() - Method in class com.elo.flows.api.components.DynamicInput
getData() - Method in class com.elo.flows.api.components.ActionResponse
getInfo() - Method in class com.elo.flows.api.components.ActionResponse
getInput() - Method in class com.elo.flows.api.components.DynamicInput
getMessage() - Method in class com.elo.flows.api.components.ActionResponse
getMessage() - Method in class com.elo.flows.api.components.DynamicInputSchemaResult
getMsg() - Method in class com.elo.flows.api.components.connection.ValidationResult: An optional message to show e.g.
getNormalizedData() - Method in class com.elo.flows.api.components.FormData: Returns a normalized form data object
getRaw() - Method in class com.elo.flows.api.components.FormData: Returns the raw form data
getSchema() - Method in class com.elo.flows.api.components.DynamicInputSchemaResult
getService() - Method in class com.elo.flows.api.components.SchemaContext: Returns the name of the related service
getServiceGroup() - Method in class com.elo.flows.api.components.SchemaContext: Returns the name of the related service-group
getState() - Method in class com.elo.flows.api.components.ActionResponse
getStatusCode() - Method in class com.elo.flows.api.components.ActionResponse
getTargetType() - Method in class com.elo.flows.api.components.SchemaContext: Returns the target type of the schema generation (e.g java.lang.Object)
getType() - Method in class com.elo.flows.api.components.SchemaContext: Returns the type of the schema generation (e.g java.lang.String)
Guide - Annotation Interface in com.elo.flows.api.components.annotations: Annotation used to add aditional information to a component or a service

I

iconUri() - Element in annotation interface com.elo.flows.api.components.annotations.Component: The Uri of the component-icon
Injectable - Annotation Interface in com.elo.flows.api.components.annotations: Injectable is a marker annotation used for declaration of a injectable class.
injectionCleanUpDisabled() - Element in annotation interface com.elo.flows.api.components.annotations.ConnectionProvider: For internal use only.
InputSchemaProvider - Annotation Interface in com.elo.flows.api.components.annotations: An annotation to mark a method as a input schema provider.
INTERNAL - Enum constant in enum class com.elo.flows.api.components.annotations.TriggerAccessType
interrupt(Class<T>) - Static method in class com.elo.flows.api.components.ActionResponse: This method is a convenience method to provide a ActionResponse.Builder fully set up to build a returnable ActionResponse that is interrupted
interrupt(Class<T>, String) - Static method in class com.elo.flows.api.components.ActionResponse: This method is a convenience method to provide a ActionResponse.Builder fully set up to build a returnable ActionResponse that is interrupted with additional information
INTERRUPTED - Enum constant in enum class com.elo.flows.api.components.ActionResponse.State
isValid() - Method in class com.elo.flows.api.components.connection.ValidationResult: Returns whether this validation process was successful

L

License - Annotation Interface in com.elo.flows.api.components.annotations: Annotation used to restrict the use of a component
LookupProvider - Annotation Interface in com.elo.flows.api.components.annotations: Annotation used to define a method as a lookup-provider.

M

MULTI - Enum constant in enum class com.elo.flows.api.components.annotations.TriggerCardinality

N

name() - Element in annotation interface com.elo.flows.api.components.annotations.Component: Name of the component
name() - Element in annotation interface com.elo.flows.api.components.annotations.ComponentServices: the name of the service-grouping
name() - Element in annotation interface com.elo.flows.api.components.annotations.Service: The name of the service
name() - Element in annotation interface com.elo.flows.api.components.annotations.StaticLookup: The name of the static lookup
name() - Element in annotation interface com.elo.flows.api.components.annotations.StoreContext
name() - Element in annotation interface com.elo.flows.api.components.annotations.Trigger: The name of the trigger
namespace() - Element in annotation interface com.elo.flows.api.components.annotations.Component: Namspace of the component
newInstance(Class<T>) - Static method in class com.elo.flows.api.components.ActionResponse.Builder: Creates a new instance of this builder class and sets the state to succeeded.

O

of(String) - Static method in class com.elo.flows.api.components.DynamicInputSchemaResult
of(String, String) - Static method in class com.elo.flows.api.components.DynamicInputSchemaResult
of(String, String, Class<?>) - Static method in class com.elo.flows.api.components.SchemaContext
of(String, String, Class<?>, Class<?>) - Static method in class com.elo.flows.api.components.SchemaContext
of(T, Object) - Static method in class com.elo.flows.api.components.DynamicInput
ok(Class<T>) - Static method in class com.elo.flows.api.components.ActionResponse: This method is a convenience method to provide a ActionResponse.Builder fully set up to build a returnable ActionResponse without a payload
ok(Class<T>, T) - Static method in class com.elo.flows.api.components.ActionResponse: This method is a convenience method to provide a ActionResponse.Builder fully set up to build a returnable ActionResponse
order() - Element in annotation interface com.elo.flows.api.components.annotations.ComponentServices: Will be used to determine the position of this group in the client
OutputSchemaProvider - Annotation Interface in com.elo.flows.api.components.annotations: An annotation to mark a method as a output schema provider.

P

ParamName - Annotation Interface in com.elo.flows.api.components.annotations: Annotation used to rewrite the name of a service-parameter.
Prepare - Annotation Interface in com.elo.flows.api.components.connection: A method in a connection provider marked with this annotation may be called in the credential setting process.
preview() - Element in annotation interface com.elo.flows.api.components.annotations.Component: Marks the component as a preview
preview() - Element in annotation interface com.elo.flows.api.components.annotations.Service: Marks the service as a preview
preview() - Element in annotation interface com.elo.flows.api.components.annotations.Trigger: Marks the trigger as a preview
provider() - Element in annotation interface com.elo.flows.api.components.annotations.Connection: the provider class to register
PUBLIC - Enum constant in enum class com.elo.flows.api.components.annotations.TriggerAccessType

R

Refresh - Annotation Interface in com.elo.flows.api.components.connection: A method in a connection provider marked with this annotation will be called to refresh a connection if necessary
resultClasses() - Element in annotation interface com.elo.flows.api.components.annotations.Synchron

S

Scheduled - Annotation Interface in com.elo.flows.api.components.annotations: Methods marked with this annotation can be scheduled as a cron job
SchemaContext - Class in com.elo.flows.api.components: The context of schema generation when calling a schema provider
SchemaProvider - Annotation Interface in com.elo.flows.api.components.annotations: Deprecated, for removal: This API element is subject to removal in a future version.
since 23.06.000, will be removed in the future, use OutputSchemaProvider instead
SchemaProvider.Compatibility - Class in com.elo.flows.api.components.annotations: Deprecated.

Hilfsklasse für die Kompatibilität
scope() - Element in annotation interface com.elo.flows.api.components.annotations.StoreContext
Service - Annotation Interface in com.elo.flows.api.components.annotations: Annotation used for service declaration.
setData(T) - Method in class com.elo.flows.api.components.ActionResponse
setInfo(String) - Method in class com.elo.flows.api.components.ActionResponse: Sets additional information that can be used for monitoring purposes
setMessage(String) - Method in class com.elo.flows.api.components.ActionResponse: Sets the message for the executed action
setMsg(String) - Method in class com.elo.flows.api.components.connection.ValidationResult: Sets a message to show.
setState(ActionResponse.State) - Method in class com.elo.flows.api.components.ActionResponse: Sets the state of the action that has been executed
setStatusCode(String) - Method in class com.elo.flows.api.components.ActionResponse: Sets the status code for the action
setValid(boolean) - Method in class com.elo.flows.api.components.connection.ValidationResult: Sets if the validation process was successful
silent() - Element in annotation interface com.elo.flows.api.components.annotations.OutputSchemaProvider: Indicates whether the output schema provider is silent (not dependend on gui settings)
silent() - Element in annotation interface com.elo.flows.api.components.annotations.SchemaProvider: Deprecated.

Indicates whether the schema provider is silent (not dependend on gui settings)
SINGLE - Enum constant in enum class com.elo.flows.api.components.annotations.TriggerCardinality
StaticLookup - Annotation Interface in com.elo.flows.api.components.annotations: Annotation used for a static lookup declaration.
StaticLookups - Annotation Interface in com.elo.flows.api.components.annotations: Annotation used to define a list of StaticLookup definitions
StoreContext - Annotation Interface in com.elo.flows.api.components.annotations: Annotation used to inject a store-context object.
StoreContext.Scope - Class in com.elo.flows.api.components.annotations
SUCCEEDED - Enum constant in enum class com.elo.flows.api.components.ActionResponse.State
Synchron - Annotation Interface in com.elo.flows.api.components.annotations: Annotation is used to mark a trigger for synchron execution

T

TempDir - Annotation Interface in com.elo.flows.api.components.annotations: Marker-Annotation used to inject a temp-directory
TEMPLATE - Static variable in class com.elo.flows.api.components.annotations.StoreContext.Scope
toOutputSchemaProvider(SchemaProvider) - Static method in class com.elo.flows.api.components.annotations.SchemaProvider.Compatibility: Deprecated.

Konvertiert die veraltete SchemaProvider Annotation in die neue OutputSchemaProvider.
Trigger - Annotation Interface in com.elo.flows.api.components.annotations: Annotation used for trigger declaration.
TriggerAccess - Annotation Interface in com.elo.flows.api.components.annotations: Sets the access constraints of a trigger
TriggerAccessType - Enum Class in com.elo.flows.api.components.annotations: Possible access-constraints of a trigger
TriggerCardinality - Enum Class in com.elo.flows.api.components.annotations: Possible cardinalities of a trigger
type() - Element in annotation interface com.elo.flows.api.components.connection.CredentialInfo: Describes what kind of credential input is used.

V

Validate - Annotation Interface in com.elo.flows.api.components.connection: a method in a connection provider marked with this annotation may be used to validate credential input.
ValidationResult - Class in com.elo.flows.api.components.connection: Validation class that can be used in an AuthenticationProvider
ValidationResult() - Constructor for class com.elo.flows.api.components.connection.ValidationResult
value() - Element in annotation interface com.elo.flows.api.components.annotations.Context
value() - Element in annotation interface com.elo.flows.api.components.annotations.Guide: The Uri of a markdown file
value() - Element in annotation interface com.elo.flows.api.components.annotations.InputSchemaProvider
value() - Element in annotation interface com.elo.flows.api.components.annotations.LookupProvider: The name of the lookup-provider
value() - Element in annotation interface com.elo.flows.api.components.annotations.OutputSchemaProvider
value() - Element in annotation interface com.elo.flows.api.components.annotations.ParamName: The name of the parameter
value() - Element in annotation interface com.elo.flows.api.components.annotations.SchemaProvider: Deprecated.
value() - Element in annotation interface com.elo.flows.api.components.annotations.StaticLookups
value() - Element in annotation interface com.elo.flows.api.components.annotations.TriggerAccess
valueOf(String) - Static method in enum class com.elo.flows.api.components.ActionResponse.State: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.elo.flows.api.components.annotations.Context.Type: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.elo.flows.api.components.annotations.TriggerAccessType: Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.elo.flows.api.components.annotations.TriggerCardinality: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.elo.flows.api.components.ActionResponse.State: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.elo.flows.api.components.annotations.Context.Type: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Element in annotation interface com.elo.flows.api.components.annotations.StaticLookup: The return values of the static lookup
values() - Static method in enum class com.elo.flows.api.components.annotations.TriggerAccessType: Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.elo.flows.api.components.annotations.TriggerCardinality: Returns an array containing the constants of this enum class, in the order they are declared.
version() - Element in annotation interface com.elo.flows.api.components.annotations.Component: The version of the component

W

WebHook - Annotation Interface in com.elo.flows.api.components.annotations: Annotation is used to declare a trigger as a webhook
withInfo(String) - Method in class com.elo.flows.api.components.ActionResponse.Builder: Sets any additional info that will be used later on in the ActionResponse
withMessage(String) - Method in class com.elo.flows.api.components.ActionResponse.Builder: Sets the message that will be used later on in the ActionResponse
withPayload(T) - Method in class com.elo.flows.api.components.ActionResponse.Builder: Sets the actual data to be used later on when instantiating the actual response object
withState(ActionResponse.State) - Method in class com.elo.flows.api.components.ActionResponse.Builder: Sets the state to later be used in the ActionResponse
withStatusCode(String) - Method in class com.elo.flows.api.components.ActionResponse.Builder: Sets the status code that will be used later on in the ActionResponse
WORKFLOW_TRIGGER_EVENT - Enum constant in enum class com.elo.flows.api.components.annotations.Context.Type

A B C D E F G I L M N O P R S T V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form