IIterationState (Jazz Client API Specification)

```
public interface IIterationState
```
Represents the initial state of an iteration as defined by a process definition. When a project area is initialized from a process definition, the process framework instantiates development lines and iterations which correspond to the state specified in the definition.

Since:

0.6

Method Summary

Methods
Modifier and Type	Method and Description
`IIterationState[]`	`getChildIterations()` Returns the iterations into which this iteration is divided.
`IDevelopmentLineState`	`getDevelopmentLine()` Returns the development line containing this iteration if it is a root iteration or `null` otherwise.
`java.lang.String`	`getEndDateData()` Returns the string describing the end date of the iteration.
`java.lang.String`	`getId()` Returns the id of the iteration this state is associated with.
`java.lang.String`	`getIterationName()` Returns the name of the iteration.
`java.lang.String`	`getIterationTypeId()` Returns the id of the iteration's type.
`IIterationState`	`getParentIteration()` Returns the parent iteration of this iteration or `null` if this iteration does not have a parent (it is rooted at a development line).
`java.lang.String`	`getStartDateData()` Returns the string describing the start date of the iteration.
`boolean`	`hasDeliverable()` Returns whether this iteration is flagged as producing planned deliverables.
`boolean`	`isCurrent()` Returns whether this iteration is flagged as the current iteration.

- Method Detail
  - getStartDateData
```
java.lang.String getStartDateData()
```
    Returns the string describing the start date of the iteration. The string should be parsed with DateFormat.
    
    Returns:
    the description of the start date
  - getEndDateData
```
java.lang.String getEndDateData()
```
    Returns the string describing the end date of the iteration. The string should be parsed with DateFormat.
    
    Returns:
    the description of the end date
  - getId
```
java.lang.String getId()
```
    Returns the id of the iteration this state is associated with.
    
    Returns:
    the id of the associated iteration
  - getIterationName
```
java.lang.String getIterationName()
```
    Returns the name of the iteration.
    
    Returns:
    the iteration name
  - getIterationTypeId
```
java.lang.String getIterationTypeId()
```
    Returns the id of the iteration's type.
    
    Returns:
    the id of the iteration's type
  - getChildIterations
```
IIterationState[] getChildIterations()
```
    Returns the iterations into which this iteration is divided. Returns an empty array if this iteration is undivided.
    
    Returns:
    the child iterations or an empty array
  - getParentIteration
```
IIterationState getParentIteration()
```
    Returns the parent iteration of this iteration or null if this iteration does not have a parent (it is rooted at a development line). When this method returns null, getDevelopmentLine() will return non-null and vice-versa.
    
    Returns:
    the parent interval or null
  - getDevelopmentLine
```
IDevelopmentLineState getDevelopmentLine()
```
    Returns the development line containing this iteration if it is a root iteration or null otherwise. When this method returns null, getParentIteration() will return non-null and vice-versa.
    
    Returns:
    the parent iteration or null
  - isCurrent
```
boolean isCurrent()
```
    Returns whether this iteration is flagged as the current iteration.
    
    Returns:
    whether this iteration is flagged as current
  - hasDeliverable
```
boolean hasDeliverable()
```
    Returns whether this iteration is flagged as producing planned deliverables.
    
    Returns:
    whether this iteration is flagged as producing planned deliverables

Interface IIterationState

Method Summary

Method Detail

getStartDateData

getEndDateData

getId

getIterationName

getIterationTypeId

getChildIterations

getParentIteration

getDevelopmentLine

isCurrent

hasDeliverable