wt.feedback
Class MultiObjectOperationProgress

java.lang.Object
  wt.feedback.MultiObjectOperationProgress

All Implemented Interfaces:

CountedProgress, MethodProgress, Serializable

public class MultiObjectOperationProgress

extends Object

implements CountedProgress, Serializable

Defines feedback that is sent to a remote client on the progress of multi-object operations since they may take a long time to complete. This class is designed to be sent to the client indirectly by using the wt.feedback.WTContextUpdate class.

See Also:

WTContextUpdate, MethodProgress, MethodProgressListener, Serialized Form

Field Summary

private int	count
private Exception	exception
private String	method
private boolean	success

Constructor Summary

MultiObjectOperationProgress(boolean success, int count, Exception exception, String method)

Method Summary

int	getCount() Gets the value of the attribute: count; The number of the object being processed
Exception	getException() Gets the value of the attribute: exception; Exception that occured while processing the current object, null if none occured.
String	getMethod() Gets the value of the attribute: method; A string constant representing the method that generated this feedback information.
boolean	isSuccess() Gets the value of the attribute: success; Indicates if operation succeeded for the current object
String	toString() Creates a string representation of this class.

Methods inherited from class java.lang.Object

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

Field Detail

success

private boolean success

exception

private Exception exception

count

private int count

method

private String method

Constructor Detail

MultiObjectOperationProgress

public MultiObjectOperationProgress(boolean success,
                                    int count,
                                    Exception exception,
                                    String method)

Method Detail

isSuccess

public boolean isSuccess()

Gets the value of the attribute: success; Indicates if operation succeeded for the current object

Returns:

boolean

getException

public Exception getException()

Gets the value of the attribute: exception; Exception that occured while processing the current object, null if none occured.

Returns:

Exception

getCount

public int getCount()

Gets the value of the attribute: count; The number of the object being processed

Specified by:

getCount in interface CountedProgress

Returns:

int

getMethod

public String getMethod()

Gets the value of the attribute: method; A string constant representing the method that generated this feedback information. Methods that wish to send feedback should define a String constant that clients can use to register a PropertyChangeListener with the WTContext in order to receive feedback for that method. The PropertyChangeEvent will have a value of type MethodProgressFeedback.

Specified by:

getMethod in interface MethodProgress

Returns:

String

See Also:

MethodProgressListener

toString

public String toString()

Creates a string representation of this class.

Returns:

String