Enterprise Information Portal APIs

com.ibm.mm.beans
Interface CMBHitItem

All Known Implementing Classes:
CMBItem

public interface CMBHitItem

This is the helper interface for the CMBSearchResults bean. This class represents the displayed attribute values of a search hit.

Since:
6.1
See Also:
CMBSearchResults

Method Summary
 boolean equals(java.lang.Object HitItem)
          Compare the pidString of two hit items
 java.lang.String[] getAttrValue()
          Gets a list of attribute values of this item
 java.lang.String getAttrValue(int index)
          Gets the attribute value at given index
 short getItemType()
          Gets the item type
 java.lang.String getPidString()
          Gets item id
 int getRanking()
          Gets the item rank value from the query
 

Method Detail

getPidString

public java.lang.String getPidString()
Gets item id
Returns:
item id

getAttrValue

public java.lang.String[] getAttrValue()
                                throws CMBException
Gets a list of attribute values of this item
Returns:
an array of attribute values in String format
Throws:
CMBException - with the following errorID:
  • CMBException.CMB_ERR_ITEM_NOT_RETRIEVED: if current item is not yet retrieved from backend server
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has been occured from the Content Server. Call CMBException.getErrorData() to get the original exception object.

getAttrValue

public java.lang.String getAttrValue(int index)
                              throws java.lang.ArrayIndexOutOfBoundsException,
                                     CMBException
Gets the attribute value at given index
Parameters:
index - the attribute index
Returns:
the value of this index attribute
Throws:
CMBException - with the following errorID:
  • CMBException.CMB_ERR_ITEM_NOT_RETRIEVED: if current item is not yet retrieved from backend server
  • CMBException.CMB_ERR_SERVER_EXCEPTION: error has been occured from the Content Server. Call CMBException.getErrorData() to get the original exception object.
java.lang.ArrayIndexOutOfBoundsException - if index is invalid.

equals

public boolean equals(java.lang.Object HitItem)
Compare the pidString of two hit items
Overrides:
equals in class java.lang.Object
Returns:
boolean

getRanking

public int getRanking()
Gets the item rank value from the query
Returns:
rank value for this item

getItemType

public short getItemType()
Gets the item type
Returns:
either CMB_TYPE_DOCUMENT or CMB_TYPE_FOLDER

EIP JavaBeans

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.