Package com.apptus.esales.connector

Class PanelContent

java.lang.Object

com.apptus.esales.connector.PanelContent

public class PanelContent
extends Object

The content of a panel as retrieved from an eSales service.

This object contains all panel attributes for the panel, as defined in eSales Manager.

For zone panels, this object contains all sub panels returned by the eSales service.

For function panels, this object contains the Result of evaluating the function in the eSales service.

An object of this class will never make new requests to the eSales service; it just holds the result of a request.

Author:

Thomas Raneland

Method Summary

Modifier and Type	Method	Description
Map<String,String>	attributes()	Returns a map of panel attributes and their values.
boolean	hasResult()	Returns true if this panel content contains a function result.
boolean	hasSubpanel(String relativePath)	Returns true if this zone contains a sub panel with the specified relative path.
boolean	isZone()	Returns true if this panel is a container, that is, contains sub panels.
Path	path()	Returns the complete path of this panel.
Result	result()	Returns the result of this panel.
Result.Ads	resultAsAds()	Fetches the result as Ads
List<Result.CategoryData>	resultAsCategoryList()	Fetches the result as a list of Result.CategoryData objects.
Result.CategoryNode	resultAsCategoryTree()	Fetches the result as a Result.CategoryNode object, representing the root of a (possibly partial) category tree.
Result.Completions	resultAsCompletions()	Fetches the result as Completions
Result.Corrections	resultAsCorrections()	Fetches the result as Corrections
Result.Count	resultAsCount()	Fetches the result as Count
Result.FacetList	resultAsFacetList()	Fetches the result as a FacetList.
Result.FacetRange	resultAsFacetRange()	Fetches the result as FacetRange
Result.Phrases	resultAsPhrases()	Fetches the result as Phrases
Result.Products	resultAsProducts()	Fetches the result as Products
Result.Values	resultAsValues()	Fetches the result as Values
PanelContent	subpanel(String relativePath)	Returns a sub panel given its relative path.
List<PanelContent>	subpanels()	Returns a list of all sub panels in this panel.
String	ticket()	Returns the ticket of the panel
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

attributes

public Map<String,String> attributes()

Returns a map of panel attributes and their values.

Returns:

a map from attribute name to attribute value

hasResult

public boolean hasResult()

Returns true if this panel content contains a function result.

Returns:

true if there is a result, false otherwise

result

public Result result()
              throws PanelException

Returns the result of this panel. If this panel is not a function panel, then returns null.

Returns:

the result of a function panel

Throws:

PanelException - if there was an error evaluating the function in the eSales service

isZone

public boolean isZone()

Returns true if this panel is a container, that is, contains sub panels.

Returns:

true if the panel contains sub panels, false otherwise

hasSubpanel

public boolean hasSubpanel(String relativePath)

Returns true if this zone contains a sub panel with the specified relative path.

Parameters:

relativePath - The simple name of the sub panel

Returns:

true if this panel contains the sub panel, false otherwise

subpanel

public PanelContent subpanel(String relativePath)

Returns a sub panel given its relative path. If the panel is not contained by this zone, then null is returned.

Parameters:

relativePath - The relative path of the sub panel

Returns:

A PanelContent object

subpanels

public List<PanelContent> subpanels()

Returns a list of all sub panels in this panel.

Returns:

a list of all sub panels in this panel.

path

public Path path()

Returns the complete path of this panel.

Returns:

the complete path of this panel.

toString

public String toString()

Overrides:

toString in class Object

ticket

public String ticket()

Returns the ticket of the panel

Returns:

the ticket of the panel

resultAsCorrections

public Result.Corrections resultAsCorrections()
                                       throws ResultTypeException,
                                              PanelException

Fetches the result as Corrections

Returns:

the result as Corrections

Throws:

ResultTypeException - if the result is not of type Corrections.

PanelException - if there was an error evaluating the function in the eSales service

resultAsCompletions

public Result.Completions resultAsCompletions()
                                       throws ResultTypeException,
                                              PanelException

Fetches the result as Completions

Returns:

the result as Completions

Throws:

ResultTypeException - if the result is not of type Completions.

PanelException - if there was an error evaluating the function in the eSales service

resultAsCount

public Result.Count resultAsCount()
                           throws ResultTypeException,
                                  PanelException

Fetches the result as Count

Returns:

the result as Count

Throws:

ResultTypeException - if the result is not of type Count.

PanelException - if there was an error evaluating the function in the eSales service

resultAsProducts

public Result.Products resultAsProducts()
                                 throws ResultTypeException,
                                        PanelException

Fetches the result as Products

Returns:

the result as Products

Throws:

ResultTypeException - if the result is not of type Products.

PanelException - if there was an error evaluating the function in the eSales service

resultAsValues

public Result.Values resultAsValues()
                             throws ResultTypeException,
                                    PanelException

Fetches the result as Values

Returns:

the result as Values

Throws:

ResultTypeException - if the result is not of type Values.

PanelException - if there was an error evaluating the function in the eSales service

resultAsPhrases

public Result.Phrases resultAsPhrases()
                               throws ResultTypeException,
                                      PanelException

Fetches the result as Phrases

Returns:

the result as Phrases

Throws:

ResultTypeException - if the result is not of type Phrases.

PanelException - if there was an error evaluating the function in the eSales service

resultAsAds

public Result.Ads resultAsAds()
                       throws ResultTypeException,
                              PanelException

Fetches the result as Ads

Returns:

the result as Ads

Throws:

ResultTypeException - if the result is not of type Ads.

PanelException - if there was an error evaluating the function in the eSales service

resultAsCategoryTree

public Result.CategoryNode resultAsCategoryTree()
                                         throws ResultTypeException,
                                                PanelException

Fetches the result as a Result.CategoryNode object, representing the root of a (possibly partial) category tree. The tree can be traversed using for example Result.CategoryNode.getSubcategories(), or utility methods such as Result.CategoryNode.getSelectedSubcategory() and Result.CategoryNode.findDescendant(String).

Returns:

The root node of a category tree as a CategoryNode object

Throws:

ResultTypeException - if the result is not of category_tree format

PanelException - if there was an error evaluating the function in the eSales service

resultAsCategoryList

public List<Result.CategoryData> resultAsCategoryList()
                                               throws PanelException,
                                                      ResultTypeException

Fetches the result as a list of Result.CategoryData objects. These objects only hold information and do not have links to subcategories or parent.

Returns:

the result as a list of categories

Throws:

ResultTypeException - if the result is not a list of categories

PanelException - if there was an error evaluating the function in the eSales service

resultAsFacetRange

public Result.FacetRange resultAsFacetRange()
                                     throws PanelException,
                                            ResultTypeException

Fetches the result as FacetRange

Returns:

the result as FacetRange

Throws:

ResultTypeException - if the result is not of type FacetRange

PanelException - if there was an error evaluating the function in the eSales service

resultAsFacetList

public Result.FacetList resultAsFacetList()
                                   throws PanelException,
                                          ResultTypeException

Fetches the result as a FacetList. The elements in the list are either Result.Values or Result.FacetRange.

Returns:

the result as a list of facets

Throws:

ResultTypeException - if the result is not of type FacetList

PanelException - if there was an error evaluating the function in the eSales service