atg.search.routing.command.search
Class SelectConfigMapping

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

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

Select config mapping, used by SelectConfig.

See Also:
Serialized Form

Field Summary
static java.lang.String CLASS_VERSION
          Class version string
 
Constructor Summary
SelectConfigMapping()
           
 
Method Summary
 boolean equals(java.lang.Object pObject)
           
protected  void getAttributeXML(java.lang.StringBuilder sb)
           
protected  void getBodyXML(java.lang.StringBuilder sb)
           
 java.lang.String getConfig()
          Returns the name of the configuration that is mapped to the given value, if any
 int getCount()
          Returns the number of candidate items that have this property value
 java.lang.String getMappingValue()
          Returns the configuration mapping (property) value
 java.lang.String getRequestTag()
           
 int getSpecificity()
          Returns the specificity value of the configuration
 boolean isSelected()
          Indicates whether this configuration was selected or not
 void setConfig(java.lang.String pConfig)
          Sets the name of the configuration that is mapped to the given value, if any
 void setCount(int pCount)
          Sets the number of candidate items that have this property value
 void setMappingValue(java.lang.String pMappingValue)
          Sets the configuration mapping (property) value
 void setSelected(boolean pSelected)
          Sets whether this configuration was selected or not
 void setSpecificity(int pSpecificity)
          Sets the specificity value of the configuration
 
Methods inherited from class atg.search.routing.command.SearchXMLObject
appendComplexXml, appendOptionalAttr, appendOptionalElem, appendOptionalElem, appendOptionalElem, appendOptionalValue, appendRequiredAttr, appendRequiredElem, appendRequiredElem, appendRequiredValue, getAllAttributeXML, getAllBodyXML, 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

SelectConfigMapping

public SelectConfigMapping()
Method Detail

equals

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

getCount

public int getCount()
Returns the number of candidate items that have this property value

Returns:
Number of candidate items that have this property value

getConfig

public java.lang.String getConfig()
Returns the name of the configuration that is mapped to the given value, if any

Returns:
The name of the configuration that is mapped to the given value, if any

getSpecificity

public int getSpecificity()
Returns the specificity value of the configuration

Returns:
Specificity value of the configuration

isSelected

public boolean isSelected()
Indicates whether this configuration was selected or not

Returns:
Whether this configuration was selected or not

getMappingValue

public java.lang.String getMappingValue()
Returns the configuration mapping (property) value

Returns:
A configuration mapping (property) value

setCount

public void setCount(int pCount)
Sets the number of candidate items that have this property value

Parameters:
pCount - Number of candidate items that have this property value

setConfig

public void setConfig(java.lang.String pConfig)
Sets the name of the configuration that is mapped to the given value, if any

Parameters:
pConfig - The name of the configuration that is mapped to the given value, if any

setSpecificity

public void setSpecificity(int pSpecificity)
Sets the specificity value of the configuration

Parameters:
pSpecificity - Specificity value of the configuration

setSelected

public void setSelected(boolean pSelected)
Sets whether this configuration was selected or not

Parameters:
pSelected - Whether this configuration was selected or not

setMappingValue

public void setMappingValue(java.lang.String pMappingValue)
Sets the configuration mapping (property) value

Parameters:
pMappingValue - A configuration mapping (property) value

getRequestTag

public java.lang.String getRequestTag()
Specified by:
getRequestTag in class atg.search.routing.command.SearchXMLObject

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