com.flexive.shared.workflow
Class StepDefinition

java.lang.Object
  extended by com.flexive.shared.AbstractSelectableObjectWithLabel
      extended by com.flexive.shared.workflow.StepDefinition
All Implemented Interfaces:
ObjectWithLabel, SelectableObject, SelectableObjectWithLabel, java.io.Serializable
Direct Known Subclasses:
StepDefinitionEdit

public class StepDefinition
extends AbstractSelectableObjectWithLabel
implements java.io.Serializable

Definition of a workflow step.

Author:
Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
See Also:
Serialized Form

Field Summary
static long EDIT_STEP_ID
          The id of the EDIT step.
protected  long id
           
protected  FxString label
           
static long LIVE_STEP_ID
          The id of the LIVE step.
protected  java.lang.String name
           
protected  long uniqueTargetId
           
 
Constructor Summary
protected StepDefinition()
          Default constructor.
  StepDefinition(FxString label, java.lang.String name, long uniqueTargetId)
          StepDefinition Constructor.
  StepDefinition(long id, FxString label, java.lang.String name, long uniqueTargetId)
          StepDefinition Constructor.
 
Method Summary
 StepDefinitionEdit asEditable()
          Returns an editable step definition object.
 long getId()
          Returns the id of the step definition
 FxString getLabel()
          Returns the label of the step definition.
 java.lang.String getName()
          Returns the name of the step definition.
 long getUniqueTargetId()
          Returns the stepDefinition used as target by the unique flag.
 boolean isSystemStepDefinition()
          Returns true if the step definition is needed by the system and can not be deleted.
 boolean isUnique()
          Returns true if only one version of a entry may be in a step using this step definition.
 java.lang.String toString()
          
 
Methods inherited from class com.flexive.shared.AbstractSelectableObjectWithLabel
equals, hashCode
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

LIVE_STEP_ID

public static final long LIVE_STEP_ID
The id of the LIVE step.

See Also:
Constant Field Values

EDIT_STEP_ID

public static final long EDIT_STEP_ID
The id of the EDIT step.

See Also:
Constant Field Values

label

protected FxString label

name

protected java.lang.String name

uniqueTargetId

protected long uniqueTargetId

id

protected long id
Constructor Detail

StepDefinition

public StepDefinition(long id,
                      FxString label,
                      java.lang.String name,
                      long uniqueTargetId)
StepDefinition Constructor.

Parameters:
label - the unique label of the step
name - the name of the step
id - the unique id of the step
uniqueTargetId - the unique target id (-1 if it there is no unique target)

StepDefinition

public StepDefinition(FxString label,
                      java.lang.String name,
                      long uniqueTargetId)
StepDefinition Constructor.

Parameters:
label - the label of the step
name - the name of the step
uniqueTargetId - the unique target id (-1 if it there is no unique target)

StepDefinition

protected StepDefinition()
Default constructor.

Method Detail

asEditable

public StepDefinitionEdit asEditable()
Returns an editable step definition object.

Returns:
this step definition as an editable object.

getLabel

public FxString getLabel()
Returns the label of the step definition.

Specified by:
getLabel in interface ObjectWithLabel
Returns:
the label of the step definition.

getName

public java.lang.String getName()
Returns the name of the step definition.

Returns:
the name of the step definition.

getId

public long getId()
Returns the id of the step definition

Specified by:
getId in interface SelectableObject
Returns:
the id of the step definition

isUnique

public boolean isUnique()
Returns true if only one version of a entry may be in a step using this step definition.

Returns:
true if only one version of a entry may be in a step using this step definition.

getUniqueTargetId

public long getUniqueTargetId()
Returns the stepDefinition used as target by the unique flag.

Returns:
the stepDefinition used as target by the unique flag.

isSystemStepDefinition

public boolean isSystemStepDefinition()
Returns true if the step definition is needed by the system and can not be deleted.

Returns:
true if the step definition is needed by the system and can not be deleted.

toString

public java.lang.String toString()

Overrides:
toString in class AbstractSelectableObjectWithLabel