com.plumtree.portaluiinfrastructure.restconsumerframework
Interface IRestResponse

All Known Implementing Classes:

RestXMLResponse

public interface IRestResponse

Method Summary

java.lang.String	GetListName() Returns the name of a node list under the root node.
XPArrayList	GetResponseList() Exclusive from GetSingleDataItem method, only one is valid in any one response
java.lang.String	GetRootElementName() Gets the name of the top level element
XPHashtable	GetSingleDataItem() Exclusive from GetResponseList method, only one is valid in any one response

Method Detail

GetListName

java.lang.String GetListName()

Returns the name of a node list under the root node. All the nodes under the root node has to share the same name to be considered a valid node list.

Returns:

null if the response content doesn't contain a list

GetRootElementName

java.lang.String GetRootElementName()

Gets the name of the top level element

Returns:

GetSingleDataItem

XPHashtable GetSingleDataItem()

Exclusive from GetResponseList method, only one is valid in any one response

Returns:

null if the response is actually a list of items

GetResponseList

XPArrayList GetResponseList()

Exclusive from GetSingleDataItem method, only one is valid in any one response

Returns:

null if the current response does not contain a top level list, XPArrayList contains XPHashtables