Package com.zendesk.sdk.model.helpcenter.help

Class SectionItem

java.lang.Object

com.zendesk.sdk.model.helpcenter.help.SectionItem

All Implemented Interfaces:

HelpItem

public class SectionItem
extends java.lang.Object
implements HelpItem

A HelpItem for Help Center sections

Field Summary

Fields inherited from interface com.zendesk.sdk.model.helpcenter.help.HelpItem

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

Constructor Summary

Constructors

Constructor and Description
SectionItem()

Method Summary

Modifier and Type	Method and Description
void	addChild(HelpItem child) Adds a child to the SectionItem
void	addChildren(java.util.List<HelpItem> children) Adds a list of child items to the SectionItem
boolean	equals(java.lang.Object o)
java.util.List<HelpItem>	getChildren() Gets the list of children that this item has.
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.
int	getTotalArticlesCount() Gets the number of articles in this SectionItem
int	getViewType() Gets the type of the item
int	hashCode()
void	removeChild(HelpItem helpItem) Removes a child from the SectionItem

Methods inherited from class java.lang.Object

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

Constructor Detail

SectionItem

public SectionItem()

Method Detail

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

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.

getChildren

public java.util.List<HelpItem> getChildren()

Description copied from interface: HelpItem

Gets the list of children that this item has.

Specified by:

getChildren in interface HelpItem

Returns:

the list of children that this item has. May be empty if there are no children, or if the item type does not permit children.

addChild

public void addChild(HelpItem child)

Adds a child to the SectionItem

Parameters:

child - the child to add to the SectionItem

addChildren

public void addChildren(java.util.List<HelpItem> children)

Adds a list of child items to the SectionItem

Parameters:

children - the child items to add

removeChild

public void removeChild(HelpItem helpItem)

Removes a child from the SectionItem

Parameters:

helpItem - the child to remove

getTotalArticlesCount

public int getTotalArticlesCount()

Gets the number of articles in this SectionItem

Returns:

the number of articles in this SectionItem

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