Step (ShrinkWrap Descriptors Aggregator 2.0.0 API)

All Superinterfaces:

Child<T>, JslStepCommType<T,Step<T>,Properties<Step<T>>,Listeners<Step<T>>,Batchlet<Step<T>>,Chunk<Step<T>>,Partition<Step<T>>>
```
public interface Step<T>
extends Child<T>, JslStepCommType<T,Step<T>,Properties<Step<T>>,Listeners<Step<T>>,Batchlet<Step<T>>,Chunk<Step<T>>,Partition<Step<T>>>
```
This interface defines the contract for the Step xsd type

Author:

Ralf Battenfeld, Andrew Lee Rubinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Step<T>`	`allowStartIfComplete(String allowStartIfComplete)` Sets the `allow-start-if-complete` attribute
`End<Step<T>>`	`createEnd()` Creates a new `end` element
`Fail<Step<T>>`	`createFail()` Creates a new `fail` element
`Next<Step<T>>`	`createNext()` Creates a new `next` element
`Stop<Step<T>>`	`createStop()` Creates a new `stop` element
`List<End<Step<T>>>`	`getAllEnd()` Returns all `end` elements
`List<Fail<Step<T>>>`	`getAllFail()` Returns all `fail` elements
`List<Next<Step<T>>>`	`getAllNext()` Returns all `next` elements
`String`	`getAllowStartIfComplete()` Returns the `allow-start-if-complete` attribute
`List<Stop<Step<T>>>`	`getAllStop()` Returns all `stop` elements
`String`	`getId()` Returns the `id` attribute
`String`	`getNext()` Returns the `next` attribute
`Batchlet<Step<T>>`	`getOrCreateBatchlet()` If not already created, a new `batchlet` element with the given value will be created.
`Chunk<Step<T>>`	`getOrCreateChunk()` If not already created, a new `chunk` element with the given value will be created.
`End<Step<T>>`	`getOrCreateEnd()` If not already created, a new `end` element will be created and returned.
`Fail<Step<T>>`	`getOrCreateFail()` If not already created, a new `fail` element will be created and returned.
`Listeners<Step<T>>`	`getOrCreateListeners()` If not already created, a new `listeners` element with the given value will be created.
`Next<Step<T>>`	`getOrCreateNext()` If not already created, a new `next` element will be created and returned.
`Partition<Step<T>>`	`getOrCreatePartition()` If not already created, a new `partition` element with the given value will be created.
`Properties<Step<T>>`	`getOrCreateProperties()` If not already created, a new `properties` element with the given value will be created.
`Stop<Step<T>>`	`getOrCreateStop()` If not already created, a new `stop` element will be created and returned.
`String`	`getStartLimit()` Returns the `start-limit` attribute
`Step<T>`	`id(String id)` Sets the `id` attribute
`Step<T>`	`next(String next)` Sets the `next` attribute
`Step<T>`	`removeAllEnd()` Removes all `end` elements
`Step<T>`	`removeAllFail()` Removes all `fail` elements
`Step<T>`	`removeAllNext()` Removes all `next` elements
`Step<T>`	`removeAllowStartIfComplete()` Removes the `allow-start-if-complete` attribute
`Step<T>`	`removeAllStop()` Removes all `stop` elements
`Step<T>`	`removeBatchlet()` Removes the `batchlet` element
`Step<T>`	`removeChunk()` Removes the `chunk` element
`Step<T>`	`removeId()` Removes the `id` attribute
`Step<T>`	`removeListeners()` Removes the `listeners` element
`Step<T>`	`removeNext()` Removes the `next` attribute
`Step<T>`	`removePartition()` Removes the `partition` element
`Step<T>`	`removeProperties()` Removes the `properties` element
`Step<T>`	`removeStartLimit()` Removes the `start-limit` attribute
`Step<T>`	`startLimit(String startLimit)` Sets the `start-limit` attribute

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

- Method Detail
  - getOrCreateEnd
```
End<Step<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<Step<T>> createEnd()
```
    Creates a new end element
    
    Returns:
    
    the new created instance of End>
  - getAllEnd
```
List<End<Step<T>>> getAllEnd()
```
    Returns all end elements
    
    Returns:
    
    list of end
  - removeAllEnd
```
Step<T> removeAllEnd()
```
    Removes all end elements
    
    Returns:
    
    the current instance of End>
  - getOrCreateFail
```
Fail<Step<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<Step<T>> createFail()
```
    Creates a new fail element
    
    Returns:
    
    the new created instance of Fail>
  - getAllFail
```
List<Fail<Step<T>>> getAllFail()
```
    Returns all fail elements
    
    Returns:
    
    list of fail
  - removeAllFail
```
Step<T> removeAllFail()
```
    Removes all fail elements
    
    Returns:
    
    the current instance of Fail>
  - getOrCreateNext
```
Next<Step<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<Step<T>> createNext()
```
    Creates a new next element
    
    Returns:
    
    the new created instance of Next>
  - getAllNext
```
List<Next<Step<T>>> getAllNext()
```
    Returns all next elements
    
    Returns:
    
    list of next
  - removeAllNext
```
Step<T> removeAllNext()
```
    Removes all next elements
    
    Returns:
    
    the current instance of Next>
  - getOrCreateStop
```
Stop<Step<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<Step<T>> createStop()
```
    Creates a new stop element
    
    Returns:
    
    the new created instance of Stop>
  - getAllStop
```
List<Stop<Step<T>>> getAllStop()
```
    Returns all stop elements
    
    Returns:
    
    list of stop
  - removeAllStop
```
Step<T> removeAllStop()
```
    Removes all stop elements
    
    Returns:
    
    the current instance of Stop>
  - getOrCreateProperties
```
Properties<Step<T>> getOrCreateProperties()
```
    If not already created, a new properties element with the given value will be created. Otherwise, the existing properties element will be returned.
    
    Returns:
    
    a new or existing instance of Properties>
  - removeProperties
```
Step<T> removeProperties()
```
    Removes the properties element
    
    Returns:
    
    the current instance of Step
  - getOrCreateListeners
```
Listeners<Step<T>> getOrCreateListeners()
```
    If not already created, a new listeners element with the given value will be created. Otherwise, the existing listeners element will be returned.
    
    Returns:
    
    a new or existing instance of Listeners>
  - removeListeners
```
Step<T> removeListeners()
```
    Removes the listeners element
    
    Returns:
    
    the current instance of Step
  - getOrCreateBatchlet
```
Batchlet<Step<T>> getOrCreateBatchlet()
```
    If not already created, a new batchlet element with the given value will be created. Otherwise, the existing batchlet element will be returned.
    
    Returns:
    
    a new or existing instance of Batchlet>
  - removeBatchlet
```
Step<T> removeBatchlet()
```
    Removes the batchlet element
    
    Returns:
    
    the current instance of Step
  - getOrCreateChunk
```
Chunk<Step<T>> getOrCreateChunk()
```
    If not already created, a new chunk element with the given value will be created. Otherwise, the existing chunk element will be returned.
    
    Returns:
    
    a new or existing instance of Chunk>
  - removeChunk
```
Step<T> removeChunk()
```
    Removes the chunk element
    
    Returns:
    
    the current instance of Step
  - getOrCreatePartition
```
Partition<Step<T>> getOrCreatePartition()
```
    If not already created, a new partition element with the given value will be created. Otherwise, the existing partition element will be returned.
    
    Returns:
    
    a new or existing instance of Partition>
  - removePartition
```
Step<T> removePartition()
```
    Removes the partition element
    
    Returns:
    
    the current instance of Step
  - id
```
Step<T> id(String id)
```
    Sets the id attribute
    
    Parameters:
    
    id - the value for the attribute id
    
    Returns:
    
    the current instance of Step
  - getId
```
String getId()
```
    Returns the id attribute
    
    Returns:
    
    the value defined for the attribute id
  - removeId
```
Step<T> removeId()
```
    Removes the id attribute
    
    Returns:
    
    the current instance of Step
  - startLimit
```
Step<T> startLimit(String startLimit)
```
    Sets the start-limit attribute
    
    Parameters:
    
    startLimit - the value for the attribute start-limit
    
    Returns:
    
    the current instance of Step
  - getStartLimit
```
String getStartLimit()
```
    Returns the start-limit attribute
    
    Returns:
    
    the value defined for the attribute start-limit
  - removeStartLimit
```
Step<T> removeStartLimit()
```
    Removes the start-limit attribute
    
    Returns:
    
    the current instance of Step
  - allowStartIfComplete
```
Step<T> allowStartIfComplete(String allowStartIfComplete)
```
    Sets the allow-start-if-complete attribute
    
    Parameters:
    
    allowStartIfComplete - the value for the attribute allow-start-if-complete
    
    Returns:
    
    the current instance of Step
  - getAllowStartIfComplete
```
String getAllowStartIfComplete()
```
    Returns the allow-start-if-complete attribute
    
    Returns:
    
    the value defined for the attribute allow-start-if-complete
  - removeAllowStartIfComplete
```
Step<T> removeAllowStartIfComplete()
```
    Removes the allow-start-if-complete attribute
    
    Returns:
    
    the current instance of Step
  - next
```
Step<T> next(String next)
```
    Sets the next attribute
    
    Parameters:
    
    next - the value for the attribute next
    
    Returns:
    
    the current instance of Step
  - getNext
```
String getNext()
```
    Returns the next attribute
    
    Returns:
    
    the value defined for the attribute next
  - removeNext
```
Step<T> removeNext()
```
    Removes the next attribute
    
    Returns:
    
    the current instance of Step

Interface Step<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

getOrCreateProperties

removeProperties

getOrCreateListeners

removeListeners

getOrCreateBatchlet

removeBatchlet

getOrCreateChunk

removeChunk

getOrCreatePartition

removePartition

id

getId

removeId

startLimit

getStartLimit

removeStartLimit

allowStartIfComplete

getAllowStartIfComplete

removeAllowStartIfComplete

next

getNext

removeNext