Category (ATG Java API)

java.lang.Object
- atg.search.routing.command.SearchXMLObject
- - atg.search.routing.command.search.Category

All Implemented Interfaces:

java.io.Serializable
```
public class Category
extends atg.search.routing.command.SearchXMLObject
```
A Category is part of the browse response BrowseRequest.Response.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CLASS_VERSION
Class version string

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CLASS_VERSION` Class version string

Constructor Summary

Constructors
Constructor and Description

Category()

Constructors
Constructor and Description
`Category()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object pObject)`
`protected void`	`getAttributeXML(java.lang.StringBuilder sb)`
`protected void`	`getBodyXML(java.lang.StringBuilder sb)`
`java.util.List`	`getChildren()` Returns List of chilren `Category`
`Category[]`	`getChildrenArray()` Returns the elements of `getChildren()` in an array
`int`	`getChildrenCount()` Returns number of children sets immediately under this document set
`int`	`getDisplayedChildren()` Returns number of returned descendent sets with respect to constraints and settings
`int`	`getDisplayedDocuments()` Returns total documents returned under this document set, with respect to constraints and settings
`int`	`getDocumentCount()` Returns total documents immediately under this document set
`java.util.List`	`getDocuments()` Returns List of `CategoryDocument`
`CategoryDocument[]`	`getDocumentsArray()` Returns the elements of `getDocuments()` as an array.
`java.util.List`	`getDocumentsWithGrouping()` These are the same documents available via `getDocuments()`, but they are returned grouped into one List per answer group (as determined by `CategoryDocument.getAnswerGroup()`.
`int`	`getHashCode()`
`int`	`getId()` Returns the topic ID, if this document set represents a topic
`java.util.List<ItemSet>`	`getItemSets()` Returns List of `ItemSet`
`ItemSet[]`	`getItemSetsArray()` Returns the elements of `getItemSets()` in an array
`java.lang.String`	`getLabel()` Returns the optional display label for document set
`java.lang.String`	`getPath()` Returns the path name of document set
`Refinements`	`getRefinements()` Returns the refinements
`java.lang.String`	`getRequestTag()` Gets the xml element tag used in the request
`int`	`getTotalChildren()` Returns total number of descendent sets under this document set and its children sets
`int`	`getTotalDocuments()` Returns total number of documents under this document set and all descendents
`int`	`getTotalGroups()` Returns total document groups, typically grouped by property
`int`	`getUniqueDocuments()` Returns the total number of unique documents under this document set and all descendents
`int`	`hashCode()`
`void`	`setChildren(java.util.List children)` Sets the list of child categories
`void`	`setChildrenCount(int childrenCount)` Sets number of children sets immediately under this document set
`void`	`setDisplayedChildren(int displayedChildren)` Sets number of returned descendent sets with respect to constraints and settings
`void`	`setDisplayedDocuments(int displayedDocuments)` Sets total documents returned under this document set, with respect to constraints and settings
`void`	`setDocumentCount(int documentCount)` Sets total documents immediately under this document set
`void`	`setDocuments(java.util.List documents)` Sets the list of `CategoryDocument`s
`void`	`setId(int id)` Sets the topic ID
`void`	`setItemSets(java.util.List<ItemSet> itemSets)` Sets List of `ItemSet`
`void`	`setLabel(java.lang.String label)` Sets the optional display label for document set
`void`	`setPath(java.lang.String path)` Sets the path name of document set
`void`	`setRefinements(Refinements refinements)` Sets refinements
`void`	`setTotalChildren(int totalChildren)` Sets total number of descendent sets under this document set and its children sets
`void`	`setTotalDocuments(int totalDocuments)` Sets total number of documents under this document set and all descendents
`void`	`setTotalGroups(int totalGroups)` Sets total document groups, typically grouped by property
`void`	`setUniqueDocuments(int uniqueDocuments)` Sets the total number of unique documents under this document set and all descendents

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, notify, notifyAll, wait, wait, wait

- Field Detail
  - CLASS_VERSION
```
public static java.lang.String CLASS_VERSION
```
    Class version string
- Constructor Detail
  - Category
```
public Category()
```
- Method Detail
  - getHashCode
```
public int getHashCode()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object pObject)
```
    Overrides:
    
    equals in class java.lang.Object
  - 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
  - getPath
```
public java.lang.String getPath()
```
    Returns the path name of document set
    
    Returns:
    
    path name of document set
  - setPath
```
public void setPath(java.lang.String path)
```
    Sets the path name of document set
    
    Parameters:
    
    path - path name of document set
  - getLabel
```
public java.lang.String getLabel()
```
    Returns the optional display label for document set
    
    Returns:
    
    Optional display label for document set
  - setLabel
```
public void setLabel(java.lang.String label)
```
    Sets the optional display label for document set
    
    Parameters:
    
    label - Optional display label for document set
  - getId
```
public int getId()
```
    Returns the topic ID, if this document set represents a topic
    
    Returns:
    
    Topic ID, if this document set represents a topic
  - setId
```
public void setId(int id)
```
    Sets the topic ID
    
    Parameters:
    
    id - Topic ID, if this document set represents a topic
  - getUniqueDocuments
```
public int getUniqueDocuments()
```
    Returns the total number of unique documents under this document set and all descendents
    
    Returns:
    
    Total number of unique documents under this document set and all descendents
  - setUniqueDocuments
```
public void setUniqueDocuments(int uniqueDocuments)
```
    Sets the total number of unique documents under this document set and all descendents
    
    Parameters:
    
    uniqueDocuments - Total number of unique documents under this document set and all descendents
  - getTotalDocuments
```
public int getTotalDocuments()
```
    Returns total number of documents under this document set and all descendents
    
    Returns:
    
    Total number of documents under this document set and all descendents
  - setTotalDocuments
```
public void setTotalDocuments(int totalDocuments)
```
    Sets total number of documents under this document set and all descendents
    
    Parameters:
    
    totalDocuments - Total number of documents under this document set and all descendents
  - getDisplayedDocuments
```
public int getDisplayedDocuments()
```
    Returns total documents returned under this document set, with respect to constraints and settings
    
    Returns:
    
    Total documents returned under this document set, with respect to constraints and settings
  - setDisplayedDocuments
```
public void setDisplayedDocuments(int displayedDocuments)
```
    Sets total documents returned under this document set, with respect to constraints and settings
    
    Parameters:
    
    displayedDocuments - Total documents returned under this document set, with respect to constraints and settings
  - getDocumentCount
```
public int getDocumentCount()
```
    Returns total documents immediately under this document set
    
    Returns:
    
    Total documents immediately under this document set
  - setDocumentCount
```
public void setDocumentCount(int documentCount)
```
    Sets total documents immediately under this document set
    
    Parameters:
    
    documentCount - Total documents immediately under this document set
  - getTotalGroups
```
public int getTotalGroups()
```
    Returns total document groups, typically grouped by property
    
    Returns:
    
    Total document groups, typically grouped by property
  - setTotalGroups
```
public void setTotalGroups(int totalGroups)
```
    Sets total document groups, typically grouped by property
    
    Parameters:
    
    totalGroups - Total document groups, typically grouped by property
  - getChildrenCount
```
public int getChildrenCount()
```
    Returns number of children sets immediately under this document set
    
    Returns:
    
    Number of children sets immediately under this document set
  - setChildrenCount
```
public void setChildrenCount(int childrenCount)
```
    Sets number of children sets immediately under this document set
    
    Parameters:
    
    childrenCount - Number of children sets immediately under this document set
  - getTotalChildren
```
public int getTotalChildren()
```
    Returns total number of descendent sets under this document set and its children sets
    
    Returns:
    
    Total number of descendent sets under this document set and its children sets
  - setTotalChildren
```
public void setTotalChildren(int totalChildren)
```
    Sets total number of descendent sets under this document set and its children sets
    
    Parameters:
    
    totalChildren - Total number of descendent sets under this document set and its children sets
  - getDisplayedChildren
```
public int getDisplayedChildren()
```
    Returns number of returned descendent sets with respect to constraints and settings
    
    Returns:
    
    Number of returned descendent sets with respect to constraints and settings
  - setDisplayedChildren
```
public void setDisplayedChildren(int displayedChildren)
```
    Sets number of returned descendent sets with respect to constraints and settings
    
    Parameters:
    
    displayedChildren - Number of returned descendent sets with respect to constraints and settings
  - getDocuments
```
public java.util.List getDocuments()
```
    Returns List of CategoryDocument
    
    Returns:
    
    List of CategoryDocument
  - getDocumentsWithGrouping
```
public java.util.List getDocumentsWithGrouping()
```
    These are the same documents available via getDocuments(), but they are returned grouped into one List per answer group (as determined by CategoryDocument.getAnswerGroup(). Thus the return value is a List of Lists, where each sub-List corresponds to a specific answer group; with the default sorting (grouping), this means each sub-List will have a single CategoryDocument.
    
    Returns:
    
    List of Lists of CategoryDocuments.
  - getDocumentsArray
```
public CategoryDocument[] getDocumentsArray()
```
    Returns the elements of getDocuments() as an array.
    
    Returns:
    
    the elements of getDocuments() as an array.
  - setDocuments
```
public void setDocuments(java.util.List documents)
```
    Sets the list of CategoryDocuments
    
    Parameters:
    
    documents - List of CategoryDocument
  - getItemSets
```
public java.util.List<ItemSet> getItemSets()
```
    Returns List of ItemSet
    
    Returns:
    
    List of ItemSet
  - getItemSetsArray
```
public ItemSet[] getItemSetsArray()
```
    Returns the elements of getItemSets() in an array
    
    Returns:
    
    the elements of getItemSets() in an array
  - setItemSets
```
public void setItemSets(java.util.List<ItemSet> itemSets)
```
    Sets List of ItemSet
    
    Parameters:
    
    itemSets - List of ItemSet
  - getRefinements
```
public Refinements getRefinements()
```
    Returns the refinements
    
    Returns:
    
    the refinements
  - setRefinements
```
public void setRefinements(Refinements refinements)
```
    Sets refinements
    
    Parameters:
    
    refinements - the refinements
  - getChildren
```
public java.util.List getChildren()
```
    Returns List of chilren Category
    
    Returns:
    
    List of Category
  - getChildrenArray
```
public Category[] getChildrenArray()
```
    Returns the elements of getChildren() in an array
    
    Returns:
    
    the elements of getChildren() in an array
  - setChildren
```
public void setChildren(java.util.List children)
```
    Sets the list of child categories
    
    Parameters:
    
    children - List of Category
  - 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

Class Category

Field Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Field Detail

CLASS_VERSION

Constructor Detail

Category

Method Detail

getHashCode

hashCode

equals

getAttributeXML

getBodyXML

getPath

setPath

getLabel

setLabel

getId

setId

getUniqueDocuments

setUniqueDocuments

getTotalDocuments

setTotalDocuments

getDisplayedDocuments

setDisplayedDocuments

getDocumentCount

setDocumentCount

getTotalGroups

setTotalGroups

getChildrenCount

setChildrenCount

getTotalChildren

setTotalChildren

getDisplayedChildren

setDisplayedChildren

getDocuments

getDocumentsWithGrouping

getDocumentsArray

setDocuments

getItemSets

getItemSetsArray

setItemSets

getRefinements

setRefinements

getChildren

getChildrenArray

setChildren

getRequestTag