atg.search.routing.command.search
Class Expansions

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

All Implemented Interfaces:

java.io.Serializable

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

Represents a loist of expansion entries. See ExpansionEntry.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

Expansions()

Method Summary

boolean	equals(java.lang.Object pObject)
protected void	getAttributeXML(java.lang.StringBuilder sb)
protected void	getBodyXML(java.lang.StringBuilder sb)
int	getCount() Returns the total number of expansions
java.util.List<ExpansionEntry>	getExpansionEntries() Returns the List of term ExpansionEntries
java.lang.String	getRequestTag() Gets the xml element tag used in the request
void	setCount(int count) Sets the total number of expansions
void	setExpansionEntries(java.util.List<ExpansionEntry> expansionEntries) Sets the List of term ExpansionEntries

Methods inherited from class atg.search.routing.command.SearchXMLObject

appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, getDefaultXmlBytes, getParentXMLObject, getXmlPath, setParentXMLObject, 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

Expansions

public Expansions()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getCount

public int getCount()

Returns the total number of expansions

Returns:

Total number of expansions

setCount

public void setCount(int count)

Sets the total number of expansions

Parameters:

count - Total number of expansions

getExpansionEntries

public java.util.List<ExpansionEntry> getExpansionEntries()

Returns the List of term ExpansionEntries

Returns:

List of term ExpansionEntries

setExpansionEntries

public void setExpansionEntries(java.util.List<ExpansionEntry> expansionEntries)

Sets the List of term ExpansionEntries

Parameters:

expansionEntries - List of term ExpansionEntries

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

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

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