Package zendesk.support

Class CategoryItem

java.lang.Object

zendesk.support.CategoryItem

All Implemented Interfaces:

HelpItem

public class CategoryItem
extends java.lang.Object
implements HelpItem

A HelpItem for Help Center categories

Field Summary

Fields inherited from interface zendesk.support.HelpItem

TYPE_ARTICLE, TYPE_CATEGORY, TYPE_LOADING, TYPE_NO_RESULTS, TYPE_PADDING, TYPE_SECTION, TYPE_SEE_ALL

Constructor Summary

Constructors

Constructor and Description
CategoryItem()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.Long	getId() Gets the ID of this item.
java.lang.String	getName() Gets the name of the item
java.lang.Long	getParentId() Returns the ID of the parent item.
java.util.List<SectionItem>	getSections()
int	getViewType() Gets the type of the item
int	hashCode()
boolean	isExpanded() Checks if the category is expanded
boolean	setExpanded(boolean expanded) Sets the expanded state.
void	setSections(java.util.List<SectionItem> sections) Sets the sections to set as the children of the category

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CategoryItem

public CategoryItem()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: HelpItem

Gets the name of the item

Specified by:

getName in interface HelpItem

Returns:

the name of the item, or an empty String if there is no name.

getId

public java.lang.Long getId()

Description copied from interface: HelpItem

Gets the ID of this item.

Specified by:

getId in interface HelpItem

Returns:

The ID of this item, or null if there is none.

getParentId

public java.lang.Long getParentId()

Description copied from interface: HelpItem

Returns the ID of the parent item.

Specified by:

getParentId in interface HelpItem

Returns:

the ID of the parent item, or null if there is none.

getSections

public java.util.List<SectionItem> getSections()

setSections

public void setSections(java.util.List<SectionItem> sections)

Sets the sections to set as the children of the category

Parameters:

sections - The sections to set as children

isExpanded

public boolean isExpanded()

Checks if the category is expanded

Returns:

true if the category is expanded, false otherwise

setExpanded

public boolean setExpanded(boolean expanded)

Sets the expanded state. Set this to true to mark the category as expanded, false otherwise.

Parameters:

expanded - the state to set for expanded. true for expanded, false for contracted

Returns:

the state of expanded after calling this method

getViewType

public int getViewType()

Description copied from interface: HelpItem

Gets the type of the item

Specified by:

getViewType in interface HelpItem

Returns:

the type of the item

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object