Package org.topbraidlive.app.framework.api.configuration

Class WorkflowRuleConfiguration

java.lang.Object

org.topbraidlive.app.framework.api.configuration.AbstractConfiguration<WorkflowRuleConfiguration>

org.topbraidlive.app.framework.api.configuration.WorkflowRuleConfiguration

public final class WorkflowRuleConfiguration
extends AbstractConfiguration<WorkflowRuleConfiguration>

Configuration returned by an app to indicate it exposes a workflow rule.

The fields are public and nullable in order to be compatible with JSON-B.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkflowRuleConfiguration.Builder

Field Summary

Fields

Modifier and Type	Field	Description
String	id	Required short identifier for the workflow rule.
String	label	Required display label of the workflow rule, such as "Example workflow rule".
WorkflowRuleType	type	Required workflow rule type.
String	url	Optional absolute or relative URL to request to execute the workflow rule.

Constructor Summary

Constructors

Constructor	Description
WorkflowRuleConfiguration()

Method Summary

Modifier and Type	Method	Description
static WorkflowRuleConfiguration.Builder	builder()
boolean	equals(Object o)
int	hashCode()
WorkflowRuleConfiguration	validate()	Validate the configuration.

Methods inherited from class org.topbraidlive.app.framework.api.configuration.AbstractConfiguration

validateNotNull, validateStringListNotBlank, validateStringNotBlank

Methods inherited from class java.lang.Object

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

Field Detail

id

public String id

Required short identifier for the workflow rule. Must follow identifier rules ([a-zA-Z_][a-zA-Z0-9_]*).

label

public String label

Required display label of the workflow rule, such as "Example workflow rule".

type

public WorkflowRuleType type

Required workflow rule type.

url

public String url

Optional absolute or relative URL to request to execute the workflow rule. If not specified it will be inferred from the app base URL and the workflow rule id. For a workflow rule "example" on app base URL "http://localhost:8081/app-example", the inferred URL would be "http://localhost:8081/app-example/workflow-rule/example". For apps deployed to the same servlet container as the EDG server, it can be useful to specify a relative url such as "/app-example/workflow-rule/example". Then the url is independent of the host and port.

Constructor Detail

WorkflowRuleConfiguration

public WorkflowRuleConfiguration()

Method Detail

builder

public static WorkflowRuleConfiguration.Builder builder()

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

validate

public final WorkflowRuleConfiguration validate()
                                         throws InvalidConfigurationException

Description copied from class: AbstractConfiguration

Validate the configuration.

Specified by:

validate in class AbstractConfiguration<WorkflowRuleConfiguration>

Returns:

this

Throws:

InvalidConfigurationException - if the configuration is invalid