org.gvsig.tools.task
Interface SimpleTaskStatus

All Superinterfaces:
CancellableTask, Observable, TaskStatus
All Known Implementing Classes:
BaseTaskStatus

public interface SimpleTaskStatus
extends TaskStatus


Method Summary
 void abort()
          Used by the task to inform that it has terminated with errors.
 void add()
          Add this TaskStatus to the TaskStatusManager.
 void cancel()
          Used by the task to inform that it has terminated cancelled by the user or another task.
 boolean getAutoRemove()
          Return the autoremove value of this TaskStatus.
 void message(String message)
          Used by the task to set a message associated to the current action of the task
 void remove()
          Remove this TaskStatus from the TaskStatusManager
 void setAutoremove(boolean autoremove)
          Used by the task to inform that this TaskStatus is removed from the manager automatically when the task is terminated and the manager need.
 void setCancellable(boolean cancellable)
          Used by the task to inform that this task es cacellable.
 void setCurValue(long value)
          Used by the task to set the current step of the task.
 void setRangeOfValues(long min, long max)
          Used by the task to set the value for min and max steps of the task.
 void setTitle(String title)
          Used by the task to set the title associated to the task.
 void setTittle(String tittle)
          Deprecated. @see setTitle(String)
 void terminate()
          Used by the task to inform that it has terminated without errors.
 
Methods inherited from interface org.gvsig.tools.task.TaskStatus
getCode, getCompleted, getLabel, getLastModification, getManager, getTitle, isAborted, isCancellable, isCancelled, isIndeterminate, isRunning
 
Methods inherited from interface org.gvsig.tools.task.CancellableTask
cancelRequest, isCancellationRequested
 
Methods inherited from interface org.gvsig.tools.observer.Observable
addObserver, deleteObserver, deleteObservers
 

Method Detail

setTittle

void setTittle(String tittle)
Deprecated. @see setTitle(String)

Used by the task to set the title associated to the task. It can't be changed.

Parameters:
tittle -

setTitle

void setTitle(String title)
Used by the task to set the title associated to the task. It can't be changed.

Parameters:
title -

message

void message(String message)
Used by the task to set a message associated to the current action of the task

Parameters:
message -

setRangeOfValues

void setRangeOfValues(long min,
                      long max)
Used by the task to set the value for min and max steps of the task. These are used with the "curvalue" to calculate the percentage of completion.

Parameters:
min -
max -

setCurValue

void setCurValue(long value)
Used by the task to set the current step of the task.

Parameters:
value -
See Also:
setRangeOfValues

terminate

void terminate()
Used by the task to inform that it has terminated without errors.


cancel

void cancel()
Used by the task to inform that it has terminated cancelled by the user or another task.


abort

void abort()
Used by the task to inform that it has terminated with errors.


remove

void remove()
Remove this TaskStatus from the TaskStatusManager


add

void add()
Add this TaskStatus to the TaskStatusManager. If TaskStatus already in the manager this is updated.


setCancellable

void setCancellable(boolean cancellable)
Used by the task to inform that this task es cacellable.

Parameters:
cancellable -

setAutoremove

void setAutoremove(boolean autoremove)
Used by the task to inform that this TaskStatus is removed from the manager automatically when the task is terminated and the manager need.

Parameters:
autoremove -

getAutoRemove

boolean getAutoRemove()
Return the autoremove value of this TaskStatus.

Returns:


Copyright © 2004-2011 gvSIG. All Rights Reserved.