atg.search.routing.command.search
Class Inspect

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

public class Inspect
extends atg.search.routing.command.SearchXMLObject
implements java.io.Serializable

Traced item inspection details

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
Inspect()
           
 
Method Summary
 boolean equals(java.lang.Object pObject)
           
protected static Inspect fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
           
protected  void getBodyXML(java.lang.StringBuilder sb)
          Override to provide the body of the xml.
 java.util.List<ItemInspect> getItems()
          Returns the list of items' details
 java.lang.String getRequestTag()
          Gets the xml element tag used in the request
protected  java.util.HashMap<java.lang.String,ItemInspect> getUrlToInspectMap()
          Returns the url-to-item inspect map
 int hashCode()
           
 void setItems(java.util.List<ItemInspect> pItems)
          Sets the list of items' details
 
Methods inherited from class atg.search.routing.command.SearchXMLObject
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getAttributeXML, 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

Inspect

public Inspect()
Method Detail

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

getItems

public java.util.List<ItemInspect> getItems()
Returns the list of items' details

Returns:
list of items' details

setItems

public void setItems(java.util.List<ItemInspect> pItems)
Sets the list of items' details

Parameters:
pItems -

getUrlToInspectMap

protected java.util.HashMap<java.lang.String,ItemInspect> getUrlToInspectMap()
Returns the url-to-item inspect map

Returns:
the url-to-item inspect map

fromXmlParser

protected static Inspect fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)

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

getBodyXML

protected void getBodyXML(java.lang.StringBuilder sb)
                   throws atg.search.routing.command.IncompleteCommandException
Override to provide the body of the xml. Do not include the main element tag.

Overrides:
getBodyXML in class atg.search.routing.command.SearchXMLObject
Parameters:
sb - shared buffer
Throws:
atg.search.routing.command.IncompleteCommandException