atg.search.routing.command.search
Class ItemRetrieval

java.lang.Object
  atg.search.routing.command.SearchXMLObject
      atg.search.routing.command.search.ItemRetrieval

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

StatementRetrieval

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

Step 1: Term look up of items, plus application of boolean logic and other limits

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

ItemRetrieval()

Method Summary

boolean	equals(java.lang.Object pObject)
protected static ItemRetrieval	fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void	getBodyXML(java.lang.StringBuilder sb)
BooleanLogic	getBooleanLogic() Returns application of boolean logic at the item level
Limits	getLimits() Returns item retrieval limits
java.lang.String	getRequestTag() Gets the xml element tag used in the request
TermLookup	getTermLookup() Returns Term lookup of item
void	setBooleanLogic(BooleanLogic pBooleanLogic) Sets boolean logic
void	setLimits(Limits pLimits) Sets item retrieval limits
void	setTermLookup(TermLookup pTermLookup) Sets Term lookup of item

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, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

ItemRetrieval

public ItemRetrieval()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getTermLookup

public TermLookup getTermLookup()

Returns Term lookup of item

Returns:

Term lookup of item

setTermLookup

public void setTermLookup(TermLookup pTermLookup)

Sets Term lookup of item

Parameters:

pTermLookup -

getBooleanLogic

public BooleanLogic getBooleanLogic()

Returns application of boolean logic at the item level

Returns:

Application of boolean logic at the item level

setBooleanLogic

public void setBooleanLogic(BooleanLogic pBooleanLogic)

Sets boolean logic

Parameters:

pBooleanLogic -

getLimits

public Limits getLimits()

Returns item retrieval limits

Returns:

item retrieval limits

setLimits

public void setLimits(Limits pLimits)

Sets item retrieval limits

Parameters:

pLimits -

fromXmlParser

protected static ItemRetrieval 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

Overrides:

getBodyXML in class atg.search.routing.command.SearchXMLObject

Throws:

atg.search.routing.command.IncompleteCommandException