oracle.apps.fnd.applcore.flex.runtime.event
Class ModelerProgressEvent

java.lang.Object
  java.util.EventObject
      oracle.apps.fnd.applcore.flex.runtime.event.ModelerEvent
          oracle.apps.fnd.applcore.flex.runtime.event.ModelerProgressEvent

All Implemented Interfaces:

java.io.Serializable

public class ModelerProgressEvent
extends ModelerEvent

An event that indicates the progress.

See Also:

Serialized Form

Nested Class Summary

static class	ModelerProgressEvent.ProgressTracker A progress tracker.
static interface	ModelerProgressEvent.Stage A stage of the process where the progress is made.

Field Summary

static ModelerProgressEvent.Stage

SINGLE_STAGE A stage that represents the whole process.

Fields inherited from class oracle.apps.fnd.applcore.flex.runtime.event.ModelerEvent

message

Fields inherited from class java.util.EventObject

source

Constructor Summary

ModelerProgressEvent(java.lang.Object source, ModelerProgressEvent.Stage stage, int value, int maximum)
Constructs a progress event.

Method Summary

int	getMaximum() Gets the maximum value.
ModelerProgressEvent.Stage	getStage() Gets the stage.
int	getValue() Gets the progress value.
static ModelerProgressEvent	newCompletedEvent(java.lang.Object source, ModelerProgressEvent.Stage stage) Creates an event that indicates a stage is completed.
java.lang.String	toString()

Methods inherited from class oracle.apps.fnd.applcore.flex.runtime.event.ModelerEvent

getMessage

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

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

Field Detail

SINGLE_STAGE

public static final ModelerProgressEvent.Stage SINGLE_STAGE

A stage that represents the whole process.

Constructor Detail

ModelerProgressEvent

public ModelerProgressEvent(java.lang.Object source,
                            ModelerProgressEvent.Stage stage,
                            int value,
                            int maximum)

Constructs a progress event.

Parameters:

source - the source of the event

stage - the stage of the task. If the given stage is null, PREPARATION is assumed.

value - the progress value; this must be zero or a positive integer. A negative value will be replaced with zero.

maximum - the maximum value; a negative value indicates that the progress cannot be determined

Method Detail

getValue

public final int getValue()

Gets the progress value.

Returns:

the progress value

getMaximum

public final int getMaximum()

Gets the maximum value.

Returns:

the maximum value

getStage

public final ModelerProgressEvent.Stage getStage()

Gets the stage.

Returns:

the stage

toString

public java.lang.String toString()

Overrides:

toString in class ModelerEvent

newCompletedEvent

public static ModelerProgressEvent newCompletedEvent(java.lang.Object source,
                                                     ModelerProgressEvent.Stage stage)

Creates an event that indicates a stage is completed.

Parameters:

source - the source of the even

stage - the stage

Returns:

the event that indicates a stage is completed