Package org.netxms.client

Class BackgroundTaskInfo

java.lang.Object

org.netxms.client.BackgroundTaskInfo

public class BackgroundTaskInfo
extends Object

State information for server-side background task

Constructor Summary

Constructors

Constructor	Description
BackgroundTaskInfo(NXCPMessage msg)	Create task information from NXCP message.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get task description.
String	getFailureReason()	Get failure reason for failed task.
int	getProgress()	Get task progress in percents (0-100).
BackgroundTaskState	getState()	Get task state.
boolean	isFailed()	Check if task has failed.
boolean	isFinished()	Check if task is finished (either successfully or not).

Methods inherited from class java.lang.Object

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

Constructor Details

BackgroundTaskInfo

public BackgroundTaskInfo(NXCPMessage msg)

Create task information from NXCP message.

Parameters:

msg - NXCP message

Method Details

getState

public BackgroundTaskState getState()

Get task state.

Returns:

task state

getProgress

public int getProgress()

Get task progress in percents (0-100).

Returns:

task progress in percents

getDescription

public String getDescription()

Get task description.

Returns:

task description

getFailureReason

public String getFailureReason()

Get failure reason for failed task.

Returns:

failure reason (empty string if task has not failed)

isFinished

public boolean isFinished()

Check if task is finished (either successfully or not).

Returns:

true if task is finished

isFailed

public boolean isFailed()

Check if task has failed.

Returns:

true if task has failed