Flow (ShrinkWrap Descriptors Aggregator 2.0.0-alpha-9 API)

All Superinterfaces:

Child<T>, JslFlowCommType<T,Flow<T>,Decision<Flow<T>>,Flow<Flow<T>>,Split<Flow<T>>,Step<Flow<T>>>
```
public interface Flow<T>
extends Child<T>, JslFlowCommType<T,Flow<T>,Decision<Flow<T>>,Flow<Flow<T>>,Split<Flow<T>>,Step<Flow<T>>>
```
This interface defines the contract for the Flow xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Decision<Flow<T>>`	`createDecision()` Creates a new `decision` element
`End<Flow<T>>`	`createEnd()` Creates a new `end` element
`Fail<Flow<T>>`	`createFail()` Creates a new `fail` element
`Flow<Flow<T>>`	`createFlow()` Creates a new `flow` element
`Next<Flow<T>>`	`createNext()` Creates a new `next` element
`Split<Flow<T>>`	`createSplit()` Creates a new `split` element
`Step<Flow<T>>`	`createStep()` Creates a new `step` element
`Stop<Flow<T>>`	`createStop()` Creates a new `stop` element
`List<Decision<Flow<T>>>`	`getAllDecision()` Returns all `decision` elements
`List<End<Flow<T>>>`	`getAllEnd()` Returns all `end` elements
`List<Fail<Flow<T>>>`	`getAllFail()` Returns all `fail` elements
`List<Flow<Flow<T>>>`	`getAllFlow()` Returns all `flow` elements
`List<Next<Flow<T>>>`	`getAllNext()` Returns all `next` elements
`List<Split<Flow<T>>>`	`getAllSplit()` Returns all `split` elements
`List<Step<Flow<T>>>`	`getAllStep()` Returns all `step` elements
`List<Stop<Flow<T>>>`	`getAllStop()` Returns all `stop` elements
`String`	`getId()` Returns the `id` attribute
`String`	`getNext()` Returns the `next` attribute
`Decision<Flow<T>>`	`getOrCreateDecision()` If not already created, a new `decision` element will be created and returned.
`End<Flow<T>>`	`getOrCreateEnd()` If not already created, a new `end` element will be created and returned.
`Fail<Flow<T>>`	`getOrCreateFail()` If not already created, a new `fail` element will be created and returned.
`Flow<Flow<T>>`	`getOrCreateFlow()` If not already created, a new `flow` element will be created and returned.
`Next<Flow<T>>`	`getOrCreateNext()` If not already created, a new `next` element will be created and returned.
`Split<Flow<T>>`	`getOrCreateSplit()` If not already created, a new `split` element will be created and returned.
`Step<Flow<T>>`	`getOrCreateStep()` If not already created, a new `step` element will be created and returned.
`Stop<Flow<T>>`	`getOrCreateStop()` If not already created, a new `stop` element will be created and returned.
`Flow<T>`	`id(String id)` Sets the `id` attribute
`Flow<T>`	`next(String next)` Sets the `next` attribute
`Flow<T>`	`removeAllDecision()` Removes all `decision` elements
`Flow<T>`	`removeAllEnd()` Removes all `end` elements
`Flow<T>`	`removeAllFail()` Removes all `fail` elements
`Flow<T>`	`removeAllFlow()` Removes all `flow` elements
`Flow<T>`	`removeAllNext()` Removes all `next` elements
`Flow<T>`	`removeAllSplit()` Removes all `split` elements
`Flow<T>`	`removeAllStep()` Removes all `step` elements
`Flow<T>`	`removeAllStop()` Removes all `stop` elements
`Flow<T>`	`removeId()` Removes the `id` attribute
`Flow<T>`	`removeNext()` Removes the `next` attribute

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up

- Method Detail
  - getOrCreateEnd
```
End<Flow<T>> getOrCreateEnd()
```
    If not already created, a new end element will be created and returned. Otherwise, the first existing end element will be returned.
    
    Returns:
    
    the instance defined for the element end
  - createEnd
```
End<Flow<T>> createEnd()
```
    Creates a new end element
    
    Returns:
    
    the new created instance of End>
  - getAllEnd
```
List<End<Flow<T>>> getAllEnd()
```
    Returns all end elements
    
    Returns:
    
    list of end
  - removeAllEnd
```
Flow<T> removeAllEnd()
```
    Removes all end elements
    
    Returns:
    
    the current instance of End>
  - getOrCreateFail
```
Fail<Flow<T>> getOrCreateFail()
```
    If not already created, a new fail element will be created and returned. Otherwise, the first existing fail element will be returned.
    
    Returns:
    
    the instance defined for the element fail
  - createFail
```
Fail<Flow<T>> createFail()
```
    Creates a new fail element
    
    Returns:
    
    the new created instance of Fail>
  - getAllFail
```
List<Fail<Flow<T>>> getAllFail()
```
    Returns all fail elements
    
    Returns:
    
    list of fail
  - removeAllFail
```
Flow<T> removeAllFail()
```
    Removes all fail elements
    
    Returns:
    
    the current instance of Fail>
  - getOrCreateNext
```
Next<Flow<T>> getOrCreateNext()
```
    If not already created, a new next element will be created and returned. Otherwise, the first existing next element will be returned.
    
    Returns:
    
    the instance defined for the element next
  - createNext
```
Next<Flow<T>> createNext()
```
    Creates a new next element
    
    Returns:
    
    the new created instance of Next>
  - getAllNext
```
List<Next<Flow<T>>> getAllNext()
```
    Returns all next elements
    
    Returns:
    
    list of next
  - removeAllNext
```
Flow<T> removeAllNext()
```
    Removes all next elements
    
    Returns:
    
    the current instance of Next>
  - getOrCreateStop
```
Stop<Flow<T>> getOrCreateStop()
```
    If not already created, a new stop element will be created and returned. Otherwise, the first existing stop element will be returned.
    
    Returns:
    
    the instance defined for the element stop
  - createStop
```
Stop<Flow<T>> createStop()
```
    Creates a new stop element
    
    Returns:
    
    the new created instance of Stop>
  - getAllStop
```
List<Stop<Flow<T>>> getAllStop()
```
    Returns all stop elements
    
    Returns:
    
    list of stop
  - removeAllStop
```
Flow<T> removeAllStop()
```
    Removes all stop elements
    
    Returns:
    
    the current instance of Stop>
  - getOrCreateDecision
```
Decision<Flow<T>> getOrCreateDecision()
```
    If not already created, a new decision element will be created and returned. Otherwise, the first existing decision element will be returned.
    
    Returns:
    
    the instance defined for the element decision
  - createDecision
```
Decision<Flow<T>> createDecision()
```
    Creates a new decision element
    
    Returns:
    
    the new created instance of Decision>
  - getAllDecision
```
List<Decision<Flow<T>>> getAllDecision()
```
    Returns all decision elements
    
    Returns:
    
    list of decision
  - removeAllDecision
```
Flow<T> removeAllDecision()
```
    Removes all decision elements
    
    Returns:
    
    the current instance of Decision>
  - getOrCreateFlow
```
Flow<Flow<T>> getOrCreateFlow()
```
    If not already created, a new flow element will be created and returned. Otherwise, the first existing flow element will be returned.
    
    Returns:
    
    the instance defined for the element flow
  - createFlow
```
Flow<Flow<T>> createFlow()
```
    Creates a new flow element
    
    Returns:
    
    the new created instance of Flow>
  - getAllFlow
```
List<Flow<Flow<T>>> getAllFlow()
```
    Returns all flow elements
    
    Returns:
    
    list of flow
  - removeAllFlow
```
Flow<T> removeAllFlow()
```
    Removes all flow elements
    
    Returns:
    
    the current instance of Flow>
  - getOrCreateSplit
```
Split<Flow<T>> getOrCreateSplit()
```
    If not already created, a new split element will be created and returned. Otherwise, the first existing split element will be returned.
    
    Returns:
    
    the instance defined for the element split
  - createSplit
```
Split<Flow<T>> createSplit()
```
    Creates a new split element
    
    Returns:
    
    the new created instance of Split>
  - getAllSplit
```
List<Split<Flow<T>>> getAllSplit()
```
    Returns all split elements
    
    Returns:
    
    list of split
  - removeAllSplit
```
Flow<T> removeAllSplit()
```
    Removes all split elements
    
    Returns:
    
    the current instance of Split>
  - getOrCreateStep
```
Step<Flow<T>> getOrCreateStep()
```
    If not already created, a new step element will be created and returned. Otherwise, the first existing step element will be returned.
    
    Returns:
    
    the instance defined for the element step
  - createStep
```
Step<Flow<T>> createStep()
```
    Creates a new step element
    
    Returns:
    
    the new created instance of Step>
  - getAllStep
```
List<Step<Flow<T>>> getAllStep()
```
    Returns all step elements
    
    Returns:
    
    list of step
  - removeAllStep
```
Flow<T> removeAllStep()
```
    Removes all step elements
    
    Returns:
    
    the current instance of Step>
  - id
```
Flow<T> id(String id)
```
    Sets the id attribute
    
    Parameters:
    
    id - the value for the attribute id
    
    Returns:
    
    the current instance of Flow
  - getId
```
String getId()
```
    Returns the id attribute
    
    Returns:
    
    the value defined for the attribute id
  - removeId
```
Flow<T> removeId()
```
    Removes the id attribute
    
    Returns:
    
    the current instance of Flow
  - next
```
Flow<T> next(String next)
```
    Sets the next attribute
    
    Parameters:
    
    next - the value for the attribute next
    
    Returns:
    
    the current instance of Flow
  - getNext
```
String getNext()
```
    Returns the next attribute
    
    Returns:
    
    the value defined for the attribute next
  - removeNext
```
Flow<T> removeNext()
```
    Removes the next attribute
    
    Returns:
    
    the current instance of Flow

Interface Flow<T>

Method Summary

Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child

Method Detail

getOrCreateEnd

createEnd

getAllEnd

removeAllEnd

getOrCreateFail

createFail

getAllFail

removeAllFail

getOrCreateNext

createNext

getAllNext

removeAllNext

getOrCreateStop

createStop

getAllStop

removeAllStop

getOrCreateDecision

createDecision

getAllDecision

removeAllDecision

getOrCreateFlow

createFlow

getAllFlow

removeAllFlow

getOrCreateSplit

createSplit

getAllSplit

removeAllSplit

getOrCreateStep

createStep

getAllStep

removeAllStep

id

getId

removeId

next

getNext

removeNext