com.neurosys.site.model

Class Progression

java.lang.Object

com.neurosys.site.model.Progression

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

MultipleStatusTrackingProgression

public class Progression
extends Object
implements Serializable

The progress of a task is encapsulated as a Progression value object. Currently the progress is only stored as an int percentage value (0 to 100) and optionally a message describing the current task.

This class has no dependency to Wicket and could be used in the service layer.

Author:

Christopher Hlubek (hlubek)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Progression(int progress) Create a new Progression value object from a percentage progress value.
Progression(int progress, String message) Create a new Progression value object from a percentage progress value and a message describing the current task

Method Summary

Modifier and Type	Method and Description
String	getMessage()
int	getProgress()
String	getProgressMessage()
boolean	isDone()
boolean	isShowProgressPercent() If false, will not show the number and only the message
void	setDone(boolean done)
void	setMessage(String message)
void	setProgress(int progress)
void	setShowProgressPercent(boolean showProgressPercent) If false, will not show the number and only the message

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Progression

public Progression(int progress)

Create a new Progression value object from a percentage progress value.

Parameters:

progress - The progress in percent from 0 to 100, where 100 means done

Progression

public Progression(int progress,
                   String message)

Create a new Progression value object from a percentage progress value and a message describing the current task

Parameters:

progress - The progress in percent from 0 to 100, where 100 means done

message - The message we'd like to show to end users

Method Detail

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

isDone

public boolean isDone()

Returns:

true if the progress is done

setProgress

public void setProgress(int progress)

getProgress

public int getProgress()

getProgressMessage

public String getProgressMessage()

isShowProgressPercent

public boolean isShowProgressPercent()

If false, will not show the number and only the message

setShowProgressPercent

public void setShowProgressPercent(boolean showProgressPercent)

If false, will not show the number and only the message

setDone

public void setDone(boolean done)