Project: stp

javax.wvcm
Class DetailedFeedback.NestedDetailedFeedback

Object
  extended by javax.wvcm.DetailedFeedback.NestedDetailedFeedback
All Implemented Interfaces:
Feedback
Enclosing class:
DetailedFeedback

public static class DetailedFeedback.NestedDetailedFeedback
extends Object
implements Feedback


Method Summary
 void abortRequested(boolean isAbortRequested)
           
 String format(String fmt, Object... arguments)
          Format a message, using MessageFormat conventions
 PropertyRequestItem.PropertyRequest getPropertyRequestForModified()
          Called by the method to determine what properties to include in the argument to Feedback.notifyIsModified(javax.wvcm.Resource).
 PropertyRequestItem.PropertyRequest getPropertyRequestForResult()
          Called by the method to determine what properties to include in the result of the operation.
 boolean isAbortRequested()
          Called by the method to determine whether the client has requested that the method be aborted.
 Feedback nest()
          Create a Feedback object like this Feedback object but with no result property request and no progress notification.
 Feedback nest(int percentCompleted)
          Create a Feedback object like this Feedback object for sub-progress notification but with a null resultPropertyRequest.
 Feedback nest(PropertyRequestItem.PropertyRequest forResult)
          Create a Feedback object like this Feedback object but with the specified property request and no progress notification.
 Feedback nest(PropertyRequestItem.PropertyRequest forResult, int percentToBeCompleted)
          Create a Feedback object like this Feedback object for sub-progress notification, but with the specified resultPropertyRequest.
 void notifyActive(String message)
          Called by the method to indicate work is progressing, but that it cannot estimate what percentage is completed.
 void notifyIsModified(Resource resource)
          Called by the method to indicate that the specified resource has been modified by the method.
 void notifyPercentComplete(int percentComplete)
          Called by the method to indicate the specified percentage of the work is complete.
 void notifyWarning(String message)
          Called by the method to indicate a warning.
 void setPropertyRequestForModified(PropertyRequestItem.PropertyRequest propertyRequestForModified)
           
 void setPropertyRequestForResult(PropertyRequestItem.PropertyRequest propertyRequestForResult)
           
 
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

abortRequested

public void abortRequested(boolean isAbortRequested)

format

public String format(String fmt,
                     Object... arguments)
Description copied from interface: Feedback
Format a message, using MessageFormat conventions

Specified by:
format in interface Feedback
Parameters:
fmt - a message that could be presented to a user. The message may be null.
arguments - objects to replace the {0},{1}, ... patterns in the message.

getPropertyRequestForModified

public PropertyRequestItem.PropertyRequest getPropertyRequestForModified()
Description copied from interface: Feedback
Called by the method to determine what properties to include in the argument to Feedback.notifyIsModified(javax.wvcm.Resource). The value of Feedback.getPropertyRequestForModified() is initialized when the Feedback object is created and is never changed. To avoid overloading the server, the client should limit this property list to the minimum set of properties needed to identify whether the resource is currently being displayed in the client GUI, and the client would then use Resource.doReadProperties(javax.wvcm.Feedback) to retrieve the information necessary to update the GUI for those resources that are currently being displayed.

Specified by:
getPropertyRequestForModified in interface Feedback
Returns:
the list of properties that the client wants to be available in the resource argument of Feedback.notifyIsModified(javax.wvcm.Resource). If this is null, no modification notifications are generated.

getPropertyRequestForResult

public PropertyRequestItem.PropertyRequest getPropertyRequestForResult()
Description copied from interface: Feedback
Called by the method to determine what properties to include in the result of the operation. The value of Feedback.getPropertyRequestForModified() is initialized when the Feedback object is created and is never changed.

Specified by:
getPropertyRequestForResult in interface Feedback
Returns:
the list of properties that the client wants to be available in the result of the operation. If this method returns null, only the Resource.RESOURCE_IDENTIFIER property is retrieved.

isAbortRequested

public boolean isAbortRequested()
Description copied from interface: Feedback
Called by the method to determine whether the client has requested that the method be aborted. The Feedback object must provide a mechanism for the client to request that a method be aborted, such as defining a requestAbort() method on the Feedback object that a thread in the client can invoke. If the method aborted because isAbortRequested() was true, the method must throw WvcmException with a WvcmException.ReasonCode.ABORTED ReasonCode. Note that when a client has requested that a method be aborted, there is no guarantee that the method will actually abort. It may instead complete successfully, or it may fail for a different reason, as indicated by throwing WvcmException with a reason code other than WvcmException.ReasonCode.ABORTED.

Specified by:
isAbortRequested in interface Feedback
Returns:
true if the client has requested that the method be aborted.

nest

public Feedback nest()
Description copied from interface: Feedback
Create a Feedback object like this Feedback object but with no result property request and no progress notification.

Specified by:
nest in interface Feedback

nest

public Feedback nest(int percentCompleted)
Description copied from interface: Feedback
Create a Feedback object like this Feedback object for sub-progress notification but with a null resultPropertyRequest.

Specified by:
nest in interface Feedback
Returns:
a Feedback object like this Feedback object for sub-progress notification but with a null resultPropertyRequest.

nest

public Feedback nest(PropertyRequestItem.PropertyRequest forResult)
Description copied from interface: Feedback
Create a Feedback object like this Feedback object but with the specified property request and no progress notification.

Specified by:
nest in interface Feedback

nest

public Feedback nest(PropertyRequestItem.PropertyRequest forResult,
                     int percentToBeCompleted)
Description copied from interface: Feedback
Create a Feedback object like this Feedback object for sub-progress notification, but with the specified resultPropertyRequest.

Specified by:
nest in interface Feedback
Returns:
a Feedback object like this Feedback object for sub-progress notification, but with the specified resultPropertyRequest.

notifyActive

public void notifyActive(String message)
Description copied from interface: Feedback
Called by the method to indicate work is progressing, but that it cannot estimate what percentage is completed.

Specified by:
notifyActive in interface Feedback
Parameters:
message - a message that could be presented to a user.

notifyIsModified

public void notifyIsModified(Resource resource)
Description copied from interface: Feedback
Called by the method to indicate that the specified resource has been modified by the method. This is primarily intended to be used by a GUI client, so that the client can update its display of resources that have been modified by the method. This function may be called multiple times during the execution of the method, usually indicating that the specified resource has been modified more than once by the method.

Specified by:
notifyIsModified in interface Feedback
Parameters:
resource - a resource that has been modified by the task. The resource must not be null.

notifyPercentComplete

public void notifyPercentComplete(int percentComplete)
Description copied from interface: Feedback
Called by the method to indicate the specified percentage of the work is complete. Note that there is no guarantee that this accurately reflects the amount of work completed.

Specified by:
notifyPercentComplete in interface Feedback
Parameters:
percentComplete - a value between 0 and 100, where 100 means the work is complete.

notifyWarning

public void notifyWarning(String message)
Description copied from interface: Feedback
Called by the method to indicate a warning.

Specified by:
notifyWarning in interface Feedback
Parameters:
message - a message that describes an anomalous situation.

setPropertyRequestForModified

public void setPropertyRequestForModified(PropertyRequestItem.PropertyRequest propertyRequestForModified)

setPropertyRequestForResult

public void setPropertyRequestForResult(PropertyRequestItem.PropertyRequest propertyRequestForResult)

Generated Mon 2-Mar-2009 11:14 PM

Copyright © IBM 2009. All rights reserved.