Class ProgressBean

java.lang.Object

ch.tocco.nice2.tasks.api.progress.ProgressBean

public class ProgressBean
extends Object

Represents the current progress of a task. Is used to inform the user (visually) about the current progress.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProgressBean.NotificationType
static enum	ProgressBean.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_ABSOLUTE	Default label for status running_absolute
static final String	DEFAULT_CANCELLED	Default label for status cancelled
static final String	DEFAULT_CANCELLED_NOTIFICATION	Default notification when a task is cancelled
static final String	DEFAULT_COMPLETED	Default label for status completed
static final String	DEFAULT_COMPLETED_NOTIFICATION	Default notification when a task is completed
static final ProgressBean.NotificationType	DEFAULT_COMPLETED_NOTIFICATION_TYPE	Default notification type when a task is completed
static final String	DEFAULT_FAILED	Default label for status failed
static final String	DEFAULT_FAILED_NOTIFICATION	Default notification when a task has failed
static final String	DEFAULT_INFINITE	Default label for status running_infinite
static final String	DEFAULT_PENDING	Default label for status pending

Constructor Summary

Constructors

Constructor	Description
ProgressBean(String taskId, String taskName, ProgressBean.Type type, String labelKey, @Nullable Map<String,String> vars)

Method Summary

Modifier and Type	Method	Description
String	getLabelKey()	Get the textresources key of the progress.
String	getTaskId()	Get the id of the task.
String	getTaskName()	Get the name of the task.
ProgressBean.Type	getType()	Get the ProgressBean.Type of the progress.
@Nullable Map<String,String>	getVars()	Get the variables (parameters for the placeholders in the label).

Methods inherited from class Object

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

Field Details

DEFAULT_PENDING

public static final String DEFAULT_PENDING

Default label for status pending

See Also:

• Constant Field Values

DEFAULT_INFINITE

public static final String DEFAULT_INFINITE

Default label for status running_infinite

See Also:

• Constant Field Values

DEFAULT_ABSOLUTE

public static final String DEFAULT_ABSOLUTE

Default label for status running_absolute

See Also:

• Constant Field Values

DEFAULT_COMPLETED

public static final String DEFAULT_COMPLETED

Default label for status completed

See Also:

• Constant Field Values

DEFAULT_FAILED

public static final String DEFAULT_FAILED

Default label for status failed

See Also:

• Constant Field Values

DEFAULT_CANCELLED

public static final String DEFAULT_CANCELLED

Default label for status cancelled

See Also:

• Constant Field Values

DEFAULT_COMPLETED_NOTIFICATION

public static final String DEFAULT_COMPLETED_NOTIFICATION

Default notification when a task is completed

See Also:

• Constant Field Values

DEFAULT_COMPLETED_NOTIFICATION_TYPE

public static final ProgressBean.NotificationType DEFAULT_COMPLETED_NOTIFICATION_TYPE

Default notification type when a task is completed

DEFAULT_FAILED_NOTIFICATION

public static final String DEFAULT_FAILED_NOTIFICATION

Default notification when a task has failed

See Also:

• Constant Field Values

DEFAULT_CANCELLED_NOTIFICATION

public static final String DEFAULT_CANCELLED_NOTIFICATION

Default notification when a task is cancelled

See Also:

• Constant Field Values

Constructor Details

ProgressBean

public ProgressBean(String taskId,
 String taskName,
 ProgressBean.Type type,
 String labelKey,
 @Nullable
 @Nullable Map<String,String> vars)

Method Details

getTaskId

public String getTaskId()

Get the id of the task.

Returns:

the id of the task

getTaskName

public String getTaskName()

Get the name of the task.

Returns:

the name of the task

getType

public ProgressBean.Type getType()

Get the ProgressBean.Type of the progress.

Returns:

the ProgressBean.Type

getLabelKey

public String getLabelKey()

Get the textresources key of the progress.

Returns:

the textressources key

getVars

@Nullable
public @Nullable Map<String,String> getVars()

Get the variables (parameters for the placeholders in the label).

Returns:

the variables