atg.search.routing.command.search
Class ItemSet

java.lang.Object
  extended by atg.search.routing.command.SearchXMLObject
      extended by atg.search.routing.command.search.ItemSet
All Implemented Interfaces:
java.io.Serializable

public class ItemSet
extends atg.search.routing.command.SearchXMLObject

Category Browse item set result

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
ItemSet()
           
 
Method Summary
 boolean equals(java.lang.Object pObject)
           
protected  void getAttributeXML(java.lang.StringBuilder sb)
           
 java.lang.String getRequestTag()
          Gets the xml element tag used in the request
 int getResultCount()
          Returns the number of items after contraining (intersecting) by this set
 int getSize()
          Returns the size of the item set
 int hashCode()
           
 boolean isInput()
          Returns an indication of whether this set came from the input or not
 void setInput(boolean input)
          Sets whether this set came from the input or not
 void setResultCount(int resultCount)
          Sets the number of items after contraining (intersecting) by this set
 void setSize(int size)
          Sets size of the item set
 
Methods inherited from class atg.search.routing.command.SearchXMLObject
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, isPrintedFirstChild, setParentXMLObject, setPrintedFirstChild, toString, toXML, toXML
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION
Class version string

Constructor Detail

ItemSet

public ItemSet()
Method Detail

getRequestTag

public java.lang.String getRequestTag()
Gets the xml element tag used in the request

Specified by:
getRequestTag in class atg.search.routing.command.SearchXMLObject
Returns:
xml element tag

equals

public boolean equals(java.lang.Object pObject)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

getAttributeXML

protected void getAttributeXML(java.lang.StringBuilder sb)
                        throws atg.search.routing.command.IncompleteCommandException
Overrides:
getAttributeXML in class atg.search.routing.command.SearchXMLObject
Throws:
atg.search.routing.command.IncompleteCommandException

getSize

public int getSize()
Returns the size of the item set

Returns:
size of the item set

setSize

public void setSize(int size)
Sets size of the item set

Parameters:
size -

isInput

public boolean isInput()
Returns an indication of whether this set came from the input or not

Returns:
whether this set came from the input or not

setInput

public void setInput(boolean input)
Sets whether this set came from the input or not

Parameters:
input -

getResultCount

public int getResultCount()
Returns the number of items after contraining (intersecting) by this set

Returns:
Number of items after contraining (intersecting) by this set

setResultCount

public void setResultCount(int resultCount)
Sets the number of items after contraining (intersecting) by this set

Parameters:
resultCount - number of items after contraining (intersecting) by this set