|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object atg.search.routing.command.SearchXMLObject atg.search.routing.command.search.FieldResponse
public class FieldResponse
Echoed field input for a TreeQueryRequest
, with additional information
about the associated results. The input class is Field
.
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Constructor Summary | |
---|---|
FieldResponse()
|
Method Summary | |
---|---|
protected static FieldResponse |
fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
|
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. |
int |
getItems()
number of items with this field, if possible |
java.lang.String |
getName()
Returns the name of the field |
Field.Op |
getOp()
Returns the operation |
java.lang.String |
getRequestTag()
Gets the xml element tag used in the request |
int |
getResults()
Returns number of results after this field has been applied against prior field results |
java.lang.String |
getValue()
Returns the field's value |
java.lang.String |
getWarn()
Returns the optional warning of query limits or other issues |
protected boolean |
isNull()
Returns true if all elements are null. |
void |
setItems(int pItems)
Sets number of items with this field, if possible |
void |
setName(java.lang.String pName)
Sets the name of the field |
void |
setOp(Field.Op pOp)
Sets the operation |
void |
setResults(int pResults)
Sets number of results after this field has been applied against prior field results |
void |
setValue(java.lang.String pValue)
Sets the Field value |
void |
setWarn(java.lang.String pWarn)
Sets the optional warning of query limits or other issues |
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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public FieldResponse()
Method Detail |
---|
protected boolean isNull()
public java.lang.String getName()
public void setName(java.lang.String pName)
pName
- name of the fieldpublic Field.Op getOp()
public void setOp(Field.Op pOp)
pOp
- operationpublic java.lang.String getValue()
public void setValue(java.lang.String pValue)
pValue
- field valuepublic java.lang.String getRequestTag()
getRequestTag
in class atg.search.routing.command.SearchXMLObject
public int getItems()
public void setItems(int pItems)
pItems
- number of items with this field, if possiblepublic int getResults()
public void setResults(int pResults)
pResults
- Number of results after this field has been applied against prior field resultspublic java.lang.String getWarn()
public void setWarn(java.lang.String pWarn)
pWarn
- Optional warning of query limits or other issuesprotected static FieldResponse fromXmlParser(atg.search.routing.utils.SearchMessageNode pXml)
protected void getAttributeXML(java.lang.StringBuilder sb) throws atg.search.routing.command.IncompleteCommandException
getAttributeXML
in class atg.search.routing.command.SearchXMLObject
sb
- shared buffer
atg.search.routing.command.IncompleteCommandException
- if required values are missingprotected void getBodyXML(java.lang.StringBuilder sb) throws atg.search.routing.command.IncompleteCommandException
getBodyXML
in class atg.search.routing.command.SearchXMLObject
sb
- shared buffer
atg.search.routing.command.IncompleteCommandException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |