Package com.apptus.esales.connector

Class DynamicPage

java.lang.Object

com.apptus.esales.connector.DynamicPage

public class DynamicPage
extends Object

A dynamic page consists of a page name and a number of subpanels. Each subpanel must point to a public panel, already defined in the eSales panel hierarchy. Use retrieveContent() to get the content of this page and all of its subpanels, recursively.

Method Summary

Modifier and Type	Method	Description
DynamicPage	addAttribute(String name, String value)	Adds a local panel attribute to this dynamic page.
DynamicPage	addAttributes(Map<String,String> attributes)	Appends a map of attributes to the local panel attributes of this dynamic page.
DynamicPage	addSubpanel(Subpanel subpanel)	Adds a subpanel to this dynamic page.
PanelContent	retrieveContent()	Retrieves the content of this dynamic page from the eSales service.
PanelContent	retrieveContent(Map<String,String> dynamicPageArguments)	Retrieves the content of this dynamic page from the eSales service.
InputStream	retrieveContentAsXml(Map<String,String> dynamicPageArguments)	Retrieves the content of this dynamic page from the eSales service as an InputStream.

Methods inherited from class java.lang.Object

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

Method Detail

addSubpanel

public DynamicPage addSubpanel(Subpanel subpanel)
                        throws DuplicateSubpanelException

Adds a subpanel to this dynamic page. Each subpanel must have a unique name.

Parameters:

subpanel - The subpanel to add

Returns:

The dynamic page with the added subpanel

Throws:

DuplicateSubpanelException - if the dynamic page already has a subpanel with the same name as the provided

addAttribute

public DynamicPage addAttribute(String name,
                                String value)

Adds a local panel attribute to this dynamic page. These attributes can be retrieved in the result using PanelContent.attributes().

Parameters:

name - The attribute name.

value - The attribute value.

Returns:

The dynamic page with the added local attribute

addAttributes

public DynamicPage addAttributes(Map<String,String> attributes)

Appends a map of attributes to the local panel attributes of this dynamic page. Any prior attributes with the same name will be overridden. These attributes can be retrieved in the result using PanelContent.attributes().

Parameters:

attributes - A map of local attributes for the dynamic page, where key is the attribute name, and value is the attribute value.

Returns:

The dynamic page with the added local attributes

retrieveContent

public PanelContent retrieveContent()
                             throws IOException,
                                    ParseException,
                                    MissingSubpanelException

Retrieves the content of this dynamic page from the eSales service. Same as calling retrieveContent(Map) with an empty map.

Returns:

A PanelContent object holding the content

Throws:

IOException - if there is an error communicating with the eSales service

ParseException - if the response cannot be parsed

MissingSubpanelException - if the dynamic page does not have any subpanels.

retrieveContent

public PanelContent retrieveContent(Map<String,String> dynamicPageArguments)
                             throws IOException,
                                    ParseException,
                                    MissingSubpanelException

Retrieves the content of this dynamic page from the eSales service. The arguments supplied to this method may be overriden by the arguments sent to the subpanels, or by the arguments already defined in the public panels referred to by the subpanels.

You may use an ArgMap or a standard HashMap to pass the arguments.

Parameters:

dynamicPageArguments - A map of arguments, where key is the parameter name, and value is the argument value. Arguments having null values are ignored.

Returns:

A PanelContent object holding the content of the dynamic page

Throws:

IOException - if there is an error communicating with the eSales service

ParseException - if the response cannot be parsed

IllegalArgumentException - if arguments contains null, empty or reserved keys

MissingSubpanelException - if the dynamic page does not have any subpanels

retrieveContentAsXml

public InputStream retrieveContentAsXml(Map<String,String> dynamicPageArguments)
                                 throws IOException,
                                        MissingSubpanelException

Retrieves the content of this dynamic page from the eSales service as an InputStream. The arguments supplied to this method may be overriden by the arguments sent to the subpanels, or by the arguments already defined in the public panels referred to by the subpanels.

You may use an ArgMap or a standard HashMap to pass the arguments.

Parameters:

dynamicPageArguments - A map of arguments, where key is the parameter name, and value is the argument value. Arguments having null values are ignored.

Returns:

An InputStream object holding the xml content of the dynamic page.

Throws:

IOException - if there is an error communicating with the eSales service

IllegalArgumentException - if arguments contains null, empty or reserved keys

MissingSubpanelException - if the dynamic page does not have any subpanels