com.ibm.eNetwork.ECL.event
Class ECLProgressEvent

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

Direct Known Subclasses:

ECLXferEvent

public class ECLProgressEvent

extends ECLEvent

Base progress event class.

Field Summary

static int	CANCEL
static int	END
static int	PROGRESS
static int	START

Constructor Summary

ECLProgressEvent(java.lang.Object source, long unitsDone, long unitsToDo)
Constructor for generating a new ECLProgressEvent.

ECLProgressEvent(java.lang.Object source, long unitsDone, long unitsToDo, int type)
Constructor for generating a new ECLProgressEvent with the specified type.

Method Summary

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

Methods inherited from class com.ibm.eNetwork.ECL.event.ECLEvent

GetSource, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

START

public static final int START

PROGRESS

public static final int PROGRESS

END

public static final int END

CANCEL

public static final int CANCEL

Constructor Detail

ECLProgressEvent

public ECLProgressEvent(java.lang.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.

ECLProgressEvent

public ECLProgressEvent(java.lang.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.

Method Detail

GetType

public int GetType()

Returns the type of progress event.

Returns:

one of the following event types: START, PROGRESS, END, CANCEL.

GetUnitsDone

public long GetUnitsDone()

Returns the total number of units of work completed.

GetUnitsToDo

public long GetUnitsToDo()

Returns the total number of units of work to do.