planetj.util
Class TaskEvent

java.lang.Object
  extended byjava.util.EventObject
      extended byplanetj.util.TaskEvent
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
TestTaskEvent

public class TaskEvent
extends java.util.EventObject

Author:
PlanetJ Corporation
See Also:
Serialized Form

Constructor Summary
TaskEvent(java.lang.Object source)
          TaskEvent constructor comment.
 
Method Summary
 java.util.Date getCompletionTime()
          Returns the time the task completed.
 java.lang.Exception getException()
          Return the Exception that occured while the task was executing.
 java.lang.Object getResult()
          Return a result from the execution of the task.
 java.util.Date getStartTime()
          Returns the time the Task started.
 void setResult(java.lang.Object pResult)
          Sets a result from the execution of the task.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TaskEvent

public TaskEvent(java.lang.Object source)
TaskEvent constructor comment.

Parameters:
source - java.lang.Object
Method Detail

getCompletionTime

public java.util.Date getCompletionTime()
Returns the time the task completed. If the task failed, the completion time is the time the task failed.

Returns:
java.util.Date

getException

public java.lang.Exception getException()
Return the Exception that occured while the task was executing. Null is returned if no exception occurred while performing the task.

Returns:
The exeception (if there was one) that occurred while performing the task.

getResult

public java.lang.Object getResult()
Return a result from the execution of the task. Depending upon the task, there might not be a result.

Returns:
The result from executing the task.

getStartTime

public java.util.Date getStartTime()
Returns the time the Task started.

Returns:
java.util.Date

setResult

public void setResult(java.lang.Object pResult)
Sets a result from the execution of the task.

Parameters:
pResult - The result from executing the task.