public static class PropertyRequestItem.PropertyRequest extends Object implements PropertyRequestItem, Feedback
If the property value is itself a resource (or a data structure containing resources),
then the PropertyRequest value of the entry for the PropertyName of that property
specifies the properties that should be retrieved for that resource.
Such a request can be constructed using the PropertyNameList.PropertyName.nest(javax.wvcm.PropertyRequestItem...)
method.
For example, the following code fragment creates a PropertyRequest that
specifies a request for the Resource.CREATOR_DISPLAY_NAME
,
ControllableResource.CHECKED_IN
, and
Resource.LAST_MODIFIED
properties, as well as the
Version.VERSION_NAME
and Resource.CREATION_DATE
properties of the resource that is the value of the
ControllableResource.CHECKED_IN
property:
PropertyRequest props = new PropertyRequest( Resource.CREATOR_DISPLAY_NAME, ControllableResource.CHECKED_IN.nest( Version.VERSION_NAME, Resource.CREATION_DATE), Resource.LAST_MODIFIED);
PropertyRequestItem.NestedPropertyName<T>, PropertyRequestItem.PropertyRequest
Modifier and Type | Field and Description |
---|---|
static PropertyRequestItem.PropertyRequest |
EMPTY
An empty PropertyRequest.
|
Constructor and Description |
---|
PropertyRequestItem.PropertyRequest(PropertyNameList.PropertyName<?>[] items)
Constructs a PropertyRequest from an array of PropertyRequestItem objects.
|
PropertyRequestItem.PropertyRequest(PropertyRequestItem... items)
Constructs a PropertyRequest from an array of PropertyRequestItem objects.
|
PropertyRequestItem.PropertyRequest(PropertyRequestItem.NestedPropertyName<?>[] items)
Constructs a PropertyRequest from an array of PropertyRequestItem objects.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object object) |
String |
format(String fmt,
Object... arguments)
Format a message, using
MessageFormat conventions |
PropertyRequestItem.PropertyRequest |
get(PropertyNameList.PropertyName<?> key) |
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.
|
int |
hashCode() |
boolean |
isAbortRequested()
Called by the method to determine whether the client has requested that the method be aborted.
|
boolean |
isEmpty() |
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.
|
int |
size() |
PropertyRequestItem.NestedPropertyName<?>[] |
toArray()
Returns an array containing all of the elements in this PropertyRequest.
|
Map<PropertyNameList.PropertyName<?>,PropertyRequestItem.PropertyRequest> |
toMap() |
String |
toString() |
public static final PropertyRequestItem.PropertyRequest EMPTY
public PropertyRequestItem.PropertyRequest(PropertyNameList.PropertyName<?>[] items)
items
- The array of PropertyRequestItem objects that are to
be combined into a new PropertyRequest.
A null or empty array produces an empty PropertyRequest.public PropertyRequestItem.PropertyRequest(PropertyRequestItem... items)
items
- The array of PropertyRequestItem objects that are to
be combined into a new PropertyRequest.
A null or empty array produces an empty PropertyRequest.public PropertyRequestItem.PropertyRequest(PropertyRequestItem.NestedPropertyName<?>[] items)
items
- The array of PropertyRequestItem objects that are to
be combined into a new PropertyRequest.
A null or empty array produces an empty PropertyRequest.public boolean equals(Object object)
equals
in class Object
public String format(String fmt, Object... arguments)
Feedback
MessageFormat
conventionspublic PropertyRequestItem.PropertyRequest get(PropertyNameList.PropertyName<?> key)
Map.get(java.lang.Object)
public PropertyRequestItem.PropertyRequest getPropertyRequestForModified()
Feedback
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.getPropertyRequestForModified
in interface Feedback
Feedback.notifyIsModified(javax.wvcm.Resource)
.
If this is null, no modification notifications are generated.public PropertyRequestItem.PropertyRequest getPropertyRequestForResult()
Feedback
Feedback.getPropertyRequestForModified()
is initialized
when the Feedback object is created and is never changed.getPropertyRequestForResult
in interface Feedback
Resource.RESOURCE_IDENTIFIER
property is retrieved.public int hashCode()
hashCode
in class Object
public boolean isAbortRequested()
Feedback
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
.isAbortRequested
in interface Feedback
public boolean isEmpty()
Map.isEmpty()
public Feedback nest()
Feedback
public Feedback nest(int percentCompleted)
Feedback
public Feedback nest(PropertyRequestItem.PropertyRequest propertyRequest)
Feedback
public Feedback nest(PropertyRequestItem.PropertyRequest resultPropertyRequest, int percentCompleted)
Feedback
public void notifyActive(String message)
Feedback
notifyActive
in interface Feedback
message
- a message that could be presented to a user.public void notifyIsModified(Resource resource)
Feedback
notifyIsModified
in interface Feedback
resource
- a resource that has been modified by the task. The resource must not be null.public void notifyPercentComplete(int percentComplete)
Feedback
notifyPercentComplete
in interface Feedback
percentComplete
- a value between 0 and 100, where 100 means the work is complete.public void notifyWarning(String message)
Feedback
notifyWarning
in interface Feedback
message
- a message that describes an anomalous situation.public int size()
Map.size()
public PropertyRequestItem.NestedPropertyName<?>[] toArray()
public Map<PropertyNameList.PropertyName<?>,PropertyRequestItem.PropertyRequest> toMap()
public String toString()
toString
in class Object
Copyright © IBM 2018. All rights reserved.