public class DetailedFeedback extends Object implements Feedback
| Modifier and Type | Class and Description |
|---|---|
static class |
DetailedFeedback.NestedDetailedFeedback |
| Constructor and Description |
|---|
DetailedFeedback() |
| Modifier and Type | Method and Description |
|---|---|
void |
abortRequested(boolean isAbortRequested) |
static Feedback |
fb(Feedback feedback)
Create a non-null Feedback object.
|
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) |
public DetailedFeedback()
public void abortRequested(boolean isAbortRequested)
public static Feedback fb(Feedback feedback)
public String format(String fmt, Object... arguments)
FeedbackMessageFormat conventionspublic PropertyRequestItem.PropertyRequest getPropertyRequestForModified()
FeedbackFeedback.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.getPropertyRequestForModified in interface FeedbackFeedback.notifyIsModified(javax.wvcm.Resource).
If this is null, no modification notifications are generated.public PropertyRequestItem.PropertyRequest getPropertyRequestForResult()
FeedbackFeedback.getPropertyRequestForModified() is initialized
when the Feedback object is created and is never changed.getPropertyRequestForResult in interface FeedbackResource.RESOURCE_IDENTIFIER
property is retrieved.public boolean isAbortRequested()
FeedbackWvcmException.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.isAbortRequested in interface Feedbackpublic Feedback nest()
Feedbackpublic Feedback nest(int percentCompleted)
Feedbackpublic Feedback nest(PropertyRequestItem.PropertyRequest forResult)
Feedbackpublic Feedback nest(PropertyRequestItem.PropertyRequest forResult, int percentToBeCompleted)
Feedbackpublic void notifyActive(String message)
FeedbacknotifyActive in interface Feedbackmessage - a message that could be presented to a user.public void notifyIsModified(Resource resource)
FeedbacknotifyIsModified in interface Feedbackresource - a resource that has been modified by the task. The resource must not be null.public void notifyPercentComplete(int percentComplete)
FeedbacknotifyPercentComplete in interface FeedbackpercentComplete - a value between 0 and 100, where 100 means the work is complete.public void notifyWarning(String message)
FeedbacknotifyWarning in interface Feedbackmessage - a message that describes an anomalous situation.public void setPropertyRequestForModified(PropertyRequestItem.PropertyRequest propertyRequestForModified)
public void setPropertyRequestForResult(PropertyRequestItem.PropertyRequest propertyRequestForResult)
Copyright © IBM 2018. All rights reserved.