|
Project: stp | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Feedback
Provides feedback on the status of a long-running method. The feedback takes the form of an indication of what Resources have been modified, and an estimate of what percentage of the work being done by the method has been completed. The feedback interface also allows the caller of the method to request that the method be aborted. Note that a client cannot count on any notify method in the Feedback interface being invoked, so a resource might be changed without notifyIsModified being invoked, and work might have been completed without notifyPercentComplete or notifyActive ever being invoked.
Method Summary | |
---|---|
String |
format(String message,
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 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 propertyRequest)
Create a Feedback object like this Feedback object but with the specified property request and no progress notification. |
Feedback |
nest(PropertyRequestItem.PropertyRequest resultPropertyRequest,
int percentCompleted)
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. |
Method Detail |
---|
String format(String message, Object... arguments)
MessageFormat
conventions
message
- 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.PropertyRequestItem.PropertyRequest getPropertyRequestForModified()
notifyIsModified(javax.wvcm.Resource)
.
The value of 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.
notifyIsModified(javax.wvcm.Resource)
.
If this is null, no modification notifications are generated.PropertyRequestItem.PropertyRequest getPropertyRequestForResult()
getPropertyRequestForModified()
is initialized
when the Feedback object is created and is never changed.
Resource.RESOURCE_IDENTIFIER
property is retrieved.boolean isAbortRequested()
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
.
Feedback nest()
Feedback nest(int percentCompleted)
Feedback nest(PropertyRequestItem.PropertyRequest propertyRequest)
Feedback nest(PropertyRequestItem.PropertyRequest resultPropertyRequest, int percentCompleted)
void notifyActive(String message)
message
- a message that could be presented to a user.void notifyIsModified(Resource resource)
resource
- a resource that has been modified by the task. The resource must not be null.void notifyPercentComplete(int percentComplete)
percentComplete
- a value between 0 and 100, where 100 means the work is complete.void notifyWarning(String message)
message
- a message that describes an anomalous situation.
|
Generated Mon 30-Jan-2017 04:26 PM | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |