atg.search.routing.command.search
Class QueryActionItem

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

All Implemented Interfaces:

java.io.Serializable

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

Represents a query rule action item. The client is responsible for interpreting individual arguments in the stored list.

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

QueryActionItem()

Method Summary

boolean	equals(java.lang.Object pQueryActionItem)
java.lang.String	getAction() Returns the rule result type
java.util.List	getActionArgs() Returns the list of String action arguments
protected void	getAttributeXML(java.lang.StringBuilder sb) Override to provide attributes.
protected void	getBodyXML(java.lang.StringBuilder sb) Override to provide the body of the xml.
java.lang.String	getId() Returns the action id
java.lang.String	getRequestTag() Gets the xml element tag used in the request
java.lang.String	getRule() Returns the name of the item
void	setAction(java.lang.String ruleResultType) Sets the rule result type
void	setActionArgs(java.util.List actionArgs) Sets the list of String action arguments
void	setId(java.lang.String pId) sets the action id
void	setRule(java.lang.String name) Sets the name of the rule

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

QueryActionItem

public QueryActionItem()

Method Detail

equals

public boolean equals(java.lang.Object pQueryActionItem)

Overrides:

equals in class java.lang.Object

getRule

public java.lang.String getRule()

Returns the name of the item

Returns:

name of the item

setRule

public void setRule(java.lang.String name)

Sets the name of the rule

Parameters:

name - name of the rule

getId

public java.lang.String getId()

Returns the action id

Returns:

action id

setId

public void setId(java.lang.String pId)

sets the action id

Parameters:

pId - action id

getAction

public java.lang.String getAction()

Returns the rule result type

Returns:

rule result type

setAction

public void setAction(java.lang.String ruleResultType)

Sets the rule result type

Parameters:

ruleResultType - rule result type

getActionArgs

public java.util.List getActionArgs()

Returns the list of String action arguments

Returns:

List of String action arguments

setActionArgs

public void setActionArgs(java.util.List actionArgs)

Sets the list of String action arguments

Parameters:

actionArgs - list of String action arguments

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

Override to provide attributes.

Overrides:

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

Parameters:

sb - shared buffer

Throws:

atg.search.routing.command.IncompleteCommandException - if required values are missing

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