Package com.apptus.esales.connector

Class Panel

java.lang.Object

com.apptus.esales.connector.Panel

public class Panel
extends Object

A panel in the eSales panel hierarchy. Use retrieveContent() to get the content of this panel and all its subpanels, recursively.

When executing panels, see the Panel library section in Apptus Zone (http://zone.apptus.com) for the arguments to each panel. When working with filters see Working with filters and the FilterBuilder class. Also read the other articles in the Key concepts section for information about the other panel arguments.

Method Summary

Modifier and Type	Method	Description
PanelContent	retrieveContent()	Same as calling retrieveContentAsXml(Map) with an empty ArgMap.
PanelContent	retrieveContent(Map<String,String> arguments)	Retrieves the content of this panel from the eSales service.
InputStream	retrieveContentAsXml(Map<String,String> arguments)	Retrieves the content of this panel 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

retrieveContent

public final PanelContent retrieveContent()
                                   throws IOException,
                                          ParseException

Same as calling retrieveContentAsXml(Map) with an empty ArgMap.

Returns:

A PanelContent object holding the content of the panel

Throws:

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

ParseException - if the response cannot be parsed

retrieveContent

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

Retrieves the content of this panel from the eSales service. The panel is evaluated with the arguments supplied to this method.

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

Parameters:

arguments - 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 panel

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

retrieveContentAsXml

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

Retrieves the content of this panel from the eSales service as an InputStream. The panel is evaluated with the arguments supplied to this method.

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

Parameters:

arguments - 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 panel.

Throws:

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

IllegalArgumentException - if arguments contains null, empty or reserved keys