atg.search.routing.command.search
Class ItemProperty

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

All Implemented Interfaces:

java.io.Serializable

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

Metadata for an inspected item

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Constructor Summary

ItemProperty()

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	getName() Returns the name of meta-data property
java.lang.String	getRequestTag() Gets the xml element tag used in the request
PropType	getType() Returns the type of property
java.lang.String	getValue() Returns the property value
boolean	isRanking() Indicates whether this property is referenced in the ranking configuration or not
boolean	isRefinement() Indicates whether this property is referenced in the refinement configuration or not
void	setName(java.lang.String pName) Sets name of meta-data property
void	setRanking(boolean pRanking) Sets whether this property is referenced in the ranking configuration or not
void	setRefinement(boolean pRefinement) Sets whether this property is referenced in the refinement configuration or not
void	setType(PropType pType) Sets the type of property
void	setValue(java.lang.String pValue) Sets the property value

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

ItemProperty

public ItemProperty()

Method Detail

equals

public boolean equals(java.lang.Object pObject)

Overrides:

equals in class java.lang.Object

getName

public java.lang.String getName()

Returns the name of meta-data property

Returns:

name of meta-data property

setName

public void setName(java.lang.String pName)

Sets name of meta-data property

Parameters:

pName -

getType

public PropType getType()

Returns the type of property

Returns:

type of property

setType

public void setType(PropType pType)

Sets the type of property

Parameters:

pType -

isRanking

public boolean isRanking()

Indicates whether this property is referenced in the ranking configuration or not

Returns:

Whether this property is referenced in the ranking configuration or not

setRanking

public void setRanking(boolean pRanking)

Sets whether this property is referenced in the ranking configuration or not

Parameters:

pRanking -

isRefinement

public boolean isRefinement()

Indicates whether this property is referenced in the refinement configuration or not

Returns:

Whether this property is referenced in the refinement configuration or not

setRefinement

public void setRefinement(boolean pRefinement)

Sets whether this property is referenced in the refinement configuration or not

Parameters:

pRefinement -

getValue

public java.lang.String getValue()

Returns the property value

Returns:

property value

setValue

public void setValue(java.lang.String pValue)

Sets the property value

Parameters:

pValue -

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

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