org.figure8.join.businessobjects.commons
Class Status

java.lang.Object
  org.figure8.join.core.EntityObject
      org.figure8.join.businessobjects.commons.Status

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Status
extends EntityObject

This is an entity representing a process status.
Some process are well identified within Join workflow such as that returned by the MANAGED_TYPES constant from this class. Defining status for these process allow you to better monitor them.
Some status should also be marked as "terminal" in order to help Join detecting process end and thus workflow transition. An exemple is the end of the assembly creation process : when assembly has reached a terminal status, Join may propose users to deploy this assembly onto an environnment ; thus starting a new deployment preparation process, and so on...

Version:

$Revision: 1.2 $

Author:

Laurent Broudoux

See Also:

Serialized Form

Field Summary

static java.lang.String	ASSEMBLY_TYPE Constant for the status type corresponding to assembly process.
static java.lang.String	BUILD_TYPE Constant for the status type corresponding to build process.
static java.lang.String	DEPLOYMENT_PREPARATION_TYPE Constant for the status type corresponding to deployment preparation process.
static java.lang.String	DEPLOYMENT_REALIZATION_TYPE Constant for the status type corresponding to deployment realisation process.
static java.lang.String[]	MANAGED_TYPES Constant for the list of managed status types (one type by process).

Constructor Summary

Status()
Creates a new insatnce of Status.

Status(java.lang.String key, java.lang.String label, java.lang.String type)
Creates a new instance of Status with mandatory attributes.

Method Summary

java.lang.String	getKey()
java.lang.String	getLabel()
java.lang.String	getType()
boolean	isCancelled()
boolean	isTerminal()
void	setCancelled(boolean cancelled)
void	setKey(java.lang.String key)
void	setLabel(java.lang.String label)
void	setTerminal(boolean terminal)
void	setType(java.lang.String type)

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

Field Detail

BUILD_TYPE

public static final java.lang.String BUILD_TYPE

Constant for the status type corresponding to build process.

See Also:

Constant Field Values

ASSEMBLY_TYPE

public static final java.lang.String ASSEMBLY_TYPE

Constant for the status type corresponding to assembly process.

See Also:

Constant Field Values

DEPLOYMENT_PREPARATION_TYPE

public static final java.lang.String DEPLOYMENT_PREPARATION_TYPE

Constant for the status type corresponding to deployment preparation process.

See Also:

Constant Field Values

DEPLOYMENT_REALIZATION_TYPE

public static final java.lang.String DEPLOYMENT_REALIZATION_TYPE

Constant for the status type corresponding to deployment realisation process.

See Also:

Constant Field Values

MANAGED_TYPES

public static final java.lang.String[] MANAGED_TYPES

Constant for the list of managed status types (one type by process).

Constructor Detail

Status

public Status()

Creates a new insatnce of Status.

Status

public Status(java.lang.String key,
              java.lang.String label,
              java.lang.String type)

Creates a new instance of Status with mandatory attributes.

Parameters:

key - The unique key for status

label - The display label for status

type - The type of process this status is for

Method Detail

getKey

public java.lang.String getKey()

Returns:

This status unique key

setKey

public void setKey(java.lang.String key)

Parameters:

key - This status unique key

getLabel

public java.lang.String getLabel()

Returns:

The display label for status

setLabel

public void setLabel(java.lang.String label)

Parameters:

label - This status label for display

getType

public java.lang.String getType()

Returns:

The type of process this status is for

setType

public void setType(java.lang.String type)

Parameters:

type - The type of process this status is for

isTerminal

public boolean isTerminal()

Returns:

Whether this status is terminal in process

setTerminal

public void setTerminal(boolean terminal)

Parameters:

terminal - Whether this status is terminal in process

isCancelled

public boolean isCancelled()

Returns:

Whether status is a cancelled one

setCancelled

public void setCancelled(boolean cancelled)

Parameters:

cancelled - Whether this status is a cancel step in process