Module aeonics.core

Package aeonics.entity

Class Step.Template

java.lang.Object

aeonics.template.Template<Step.Type>

aeonics.entity.Step.Template

All Implemented Interfaces:

Documented, Exportable

Enclosing class:

Step

public static class Step.Template
extends Template<Step.Type>

Template for all step entities

Constructor Summary

Constructors

Constructor	Description
Template(java.lang.Class<? extends Step.Type> target, java.lang.Class<? extends Step> type, java.lang.Class<? extends Step> category)	Creates a new step template

Method Summary

Modifier and Type	Method	Description
Data	export()	Renders this class instance to a simple data structure for rendering client-side.
java.lang.String	icon()	Returns the name of the icon used to render this step visually.
<T extends Step.Template> T	icon(java.lang.String value)	Sets the name of the icon used to render this step visually.
<T extends Step.Template> T	input(Channel channel)	Adds an input channel
java.util.List<Channel>	inputs()	Returns the list of input channels for this flow item
<T extends Step.Template> T	output(Channel channel)	Adds an output channel
java.util.List<Channel>	outputs()	Returns the list of output channels for this flow item
Step.ROLE	role()	Returns the role of this step in the flow.

Methods inherited from class aeonics.template.Template

add, add, cast, category, category, category, config, config, config, config, config, create, create, creator, description, description, enforceParameterValidation, enforceParameterValidation, name, onCreate, onUpdate, removeParameter, removeRelationship, summary, summary, target, target, type, type, update

Methods inherited from class java.lang.Object

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

Constructor Detail

Template

public Template(java.lang.Class<? extends Step.Type> target,
                java.lang.Class<? extends Step> type,
                java.lang.Class<? extends Step> category)

Creates a new step template

Parameters:

target - the target entity target type

type - the item type

category - the item category

Method Detail

inputs

public java.util.List<Channel> inputs()

Returns the list of input channels for this flow item

Returns:

the list of input channels for this flow item

input

public <T extends Step.Template> T input(Channel channel)

Adds an input channel

Type Parameters:

T - this type

Parameters:

channel - the channel to add

Returns:

this

outputs

public java.util.List<Channel> outputs()

Returns the list of output channels for this flow item

Returns:

the list of output channels for this flow item

output

public <T extends Step.Template> T output(Channel channel)

Adds an output channel

Type Parameters:

T - this type

Parameters:

channel - the channel to add

Returns:

this

icon

public java.lang.String icon()

Returns the name of the icon used to render this step visually.

Returns:

the icon name

icon

public <T extends Step.Template> T icon(java.lang.String value)

Sets the name of the icon used to render this step visually.

Type Parameters:

T - the template type

Parameters:

value - the icon

Returns:

this

role

public Step.ROLE role()

Returns the role of this step in the flow.

Returns:

the role of this step in the flow

export

public Data export()

Description copied from interface: Exportable

Renders this class instance to a simple data structure for rendering client-side.

Specified by:

export in interface Documented

Specified by:

export in interface Exportable

Overrides:

export in class Template<Step.Type>

Returns:

a public data representation of this class instance