org.figure8.join.businessobjects.commons
Class Step

java.lang.Object
  org.figure8.join.core.EntityObject
      org.figure8.join.core.SortableEntityObject
          org.figure8.join.businessobjects.commons.Step

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class Step
extends SortableEntityObject

This is an entity representing an Integration process step.
Steps and their position helps defining the integration process and thus the lifecycle of managed artifacts and environments.
Steps may also help defining business and transition rules. e.g : an artifact may have to be deployed on an environment corresponding to step one "acceptance tests" before being deployed on another environment corresponding to step two "non regression tests".

Version:

$Revision: 1.5 $

Author:

Laurent Broudoux

See Also:

Serialized Form

Constructor Summary

Step()
Creates a new instance of Step

Step(java.lang.String label, int position)
Creates a new instance of Step with mandatory params.

Method Summary

java.lang.String	getLabel()
Step	getNextStep()
int	getPosition()
Step	getPreviousStep()
java.lang.String	getStringForComparison() Get the comparision criterion as a string.
void	setLabel(java.lang.String label)
void	setNextStep(Step nextStep)
void	setPosition(int position)
void	setPreviousStep(Step previousStep)
void	shiftPosition() Shift the position of this step and its followers into integration process.

Methods inherited from class org.figure8.join.core.SortableEntityObject

compareTo

Methods inherited from class org.figure8.join.core.EntityObject

clone, equals, getId, hashCode, isTransient

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Step

public Step()

Creates a new instance of Step

Step

public Step(java.lang.String label,
            int position)

Creates a new instance of Step with mandatory params.

Parameters:

label - This step label

position - This step position within integration cycle.

Method Detail

getLabel

public java.lang.String getLabel()

Returns:

This release label

setLabel

public void setLabel(java.lang.String label)

Parameters:

label - This step label

getPosition

public int getPosition()

Returns:

This position within cycle

setPosition

public void setPosition(int position)

Parameters:

position - The position in this step within integration cycle

getNextStep

public Step getNextStep()

Returns:

The next step within integration cycle

setNextStep

public void setNextStep(Step nextStep)

Parameters:

nextStep - The next step within integration cycle

getPreviousStep

public Step getPreviousStep()

Returns:

The previous step within integration cycle

setPreviousStep

public void setPreviousStep(Step previousStep)

Parameters:

previousStep - The previous step within integration cycle

shiftPosition

public void shiftPosition()

Shift the position of this step and its followers into integration process.

getStringForComparison

public java.lang.String getStringForComparison()

Get the comparision criterion as a string. Step position here.

Specified by:

getStringForComparison in class SortableEntityObject

Returns:

The string representation of comparison and sort cirterion