org.jsondoc.core.annotation

Annotation Type ApiFlow

@Documented
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
public @interface ApiFlow

This annotation is to be used on a method (typically on a class dedicated to flow description) and contains an array of ApiFlowStep

Author:

Fabio Maffioletti

See Also:

ApiFlowStep

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The name of the flow

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	description The description of the flow
String	group With this it is possible to specify the logical grouping of this flow.
String[]	preconditions The preconditions for this flow (example: "the user must be logged", "the user must have an administration role")
ApiFlowStep[]	steps An array of ApiFlowStep annotations

Element Detail

name

public abstract String name

The name of the flow

Returns:

description

public abstract String description

The description of the flow

Returns:

Default:

""

preconditions

public abstract String[] preconditions

The preconditions for this flow (example: "the user must be logged", "the user must have an administration role")

Returns:

Default:

{}

steps

public abstract ApiFlowStep[] steps

An array of ApiFlowStep annotations

Returns:

See Also:

ApiFlowStep

Default:

{}

group

public abstract String group

With this it is possible to specify the logical grouping of this flow. See the same property in the @Api annotation.

Returns:

Default:

""