Package com.apptus.esales.connector

Class Result.Category

java.lang.Object

com.apptus.esales.connector.Result.Category

All Implemented Interfaces:

Iterable<Result.Attribute>

Direct Known Subclasses:

Result.CategoryData, Result.CategoryNode

Enclosing interface:

Result

public abstract static class Result.Category
extends Object
implements Iterable<Result.Attribute>

A common abstraction for the Result.CategoryNode and Result.CategoryData classes.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Result.Attribute	getAttribute(String name)	Get the attribute with the specified name or null if no such attribute exists for this category.
String	getDisplayName()	Get the display name of this category.
String	getLocale()	Get the locale of this category.
String	getParentKey()	Get the parent key of this category.
int	getProductCount()	Get the number of products in this category.
String	getTicket()	Get the notification ticket of this category.
String	getValue(String attributeName)	Get the attribute with the specified name from this category or null if no such attribute exists.
String	getValue(String attributeName, String defaultValue)	Get the value of the attribute with the specified attributeName.
int	hashCode()
Iterator<Result.Attribute>	iterator()
String	key()	Return the key of this category.
String	toString()

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Method Detail

getAttribute

public final Result.Attribute getAttribute(String name)

Get the attribute with the specified name or null if no such attribute exists for this category.

Parameters:

name - the name of the attribute to get

Returns:

the attribute with the specified name or null

key

public final String key()

Return the key of this category.

Returns:

the key of this category

getValue

public final String getValue(String attributeName)

Get the attribute with the specified name from this category or null if no such attribute exists.

Parameters:

attributeName - the name of the attribute whose value to retrieve

Returns:

the attribute with the specified name or null if this category has no such attribute

getValue

public final String getValue(String attributeName,
                             String defaultValue)

Get the value of the attribute with the specified attributeName. The specified defaultValue will be returned if no such attribute exists.

Parameters:

attributeName - the name of the attribute whose value to retrieve

defaultValue - the value to return if this category doesn't have an attribute with the specified attributeName

Returns:

The attribute value of attribute with the specified attributeName. The supplied defaultValue will be returned if this category has no attribute matching the name.

toString

public String toString()

Overrides:

toString in class Object

getTicket

public String getTicket()

Get the notification ticket of this category.

Returns:

the ticket

getDisplayName

public String getDisplayName()

Get the display name of this category.

Returns:

the display name

getParentKey

public String getParentKey()

Get the parent key of this category. Sometimes the parent key may be available even though the parent category itself has not been fetched from the server.

Returns:

the parent key of this category

getLocale

public String getLocale()

Get the locale of this category.

Returns:

the locale

getProductCount

public int getProductCount()

Get the number of products in this category.

Returns:

The total number of products contained in this category. Returns -1 if a count is not available for the current panel.

iterator

public Iterator<Result.Attribute> iterator()

Specified by:

iterator in interface Iterable<Result.Attribute>

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object