Project: stp

com.ibm.rational.wvcm.stp.cq
Interface CqHit


public interface CqHit

Information about one record matching by a full-text search query.


Method Summary
 String getDisplayName()
           
 long getIndexedVersion()
           
 PropertyNameList getPropertyNames()
           
 List<String> getPropertyValues()
           
 int getScore()
           
 StpLocation getStableLocation()
           
 StpLocation getUserFriendlyLocation()
           
 long getVersion()
           
 boolean notCurrent()
           
 

Method Detail

getDisplayName

String getDisplayName()
Returns:
A String of displayName for each record in this hit. The displayName is returned by getDisplayName().

getIndexedVersion

long getIndexedVersion()
Returns:
The version of the hit resource whose content has been indexed. If the value you get back from this call and from getVersion() are different, the indexing has not yet caught-up with the updates in the database.

getPropertyNames

PropertyNameList getPropertyNames()
Returns:
A PropertyNameList containing a PropertyName for each property of the resource whose value is reported in this hit item. This list is determined by the database administrator and cannot be changed by any method in this API. The ordering of this list matches the ordering of the values returned by getPropertyValues().

getPropertyValues

List<String> getPropertyValues()
Returns:
A List containing a value for each property of the resource reported in this hit. The number and ordering of these values matches the number and ordering of the PropertyNames returned by getPropertyNames().

getScore

int getScore()
Returns:
The score or rank (from 1 to 100) of this hit compared to the other hits of the result set. It’s common to have one or more hits with the same score.

getStableLocation

StpLocation getStableLocation()
Returns:
The value of the STABLE_LOCATION property of the hit resource.

getUserFriendlyLocation

StpLocation getUserFriendlyLocation()
Returns:
The value of the USER_FRIENDLY_LOCATION property of the hit resource.

getVersion

long getVersion()
Returns:
The version of the hit resource in the ClearQuest database.

notCurrent

boolean notCurrent()
Returns:
true if the version of the resource that generated this hit in the indexed content of the database is different from the version that currently exists in the database. Use this information to let the user know that this hit item may change when indexing catches up with the database. For example, it’s possible this hit item will not show up as a hit for the same search when rerun.

Generated Fri 13-Jun-2014 11:11 PM

Copyright © IBM 2014. All rights reserved.