All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.ECL.event.ECLProgressEvent

java.lang.Object
   |
   +----com.ibm.eNetwork.ECL.event.ECLEvent
           |
           +----com.ibm.eNetwork.ECL.event.ECLProgressEvent

public class ECLProgressEvent
extends ECLEvent
Base progress event class.


Variable Index

 o CANCEL
 o END
 o PROGRESS
 o START

Constructor Index

 o ECLProgressEvent(Object, long, long)
Constructor for generating a new ECLProgressEvent.
 o ECLProgressEvent(Object, long, long, int)
Constructor for generating a new ECLProgressEvent with the specified type.

Method Index

 o GetType()
Returns the type of progress event.
 o GetUnitsDone()
Returns the total number of units of work completed.
 o GetUnitsToDo()
Returns the total number of units of work to do.

Variables

 o START
 public static final int START
 o PROGRESS
 public static final int PROGRESS
 o END
 public static final int END
 o CANCEL
 public static final int CANCEL

Constructors

 o ECLProgressEvent
 public ECLProgressEvent(Object source,
                         long unitsDone,
                         long unitsToDo)
Constructor for generating a new ECLProgressEvent. If unitsDone is zero, the event type will be START. If unitsDone equals unitsToDo, the event type will be END. In all other cases, the event type will default to PROGRESS.

Parameters:
source - The source of the event.
unitsDone - The number of units of work done.
unitsToDo - The total number of units of work to do.
 o ECLProgressEvent
 public ECLProgressEvent(Object source,
                         long unitsDone,
                         long unitsToDo,
                         int type)
Constructor for generating a new ECLProgressEvent with the specified type.

Parameters:
source - The source of the event.
unitsDone - The number of units of work done.
unitsToDo - The total number of units of work to do.
type - The type of event.

Methods

 o GetType
 public int GetType()
Returns the type of progress event.

Returns:
one of the following event types: START, PROGRESS, END, CANCEL.
 o GetUnitsDone
 public long GetUnitsDone()
Returns the total number of units of work completed.

 o GetUnitsToDo
 public long GetUnitsToDo()
Returns the total number of units of work to do.


All Packages  Class Hierarchy  This Package  Previous  Next  Index