com.hyfinity.java

Class RequestData

java.lang.Object

com.hyfinity.java.RequestData

public class RequestData
extends java.lang.Object

Provides access to the data for a given request.

Version:

1.0

Author:

Hyfinity Ltd. Copyright (c) 2017

Constructor Summary

Constructors

Constructor and Description
RequestData(XDocument request) RequestData constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getActionName() Returns the name of the action that was called from the page.
JSONObject	getAsJSON() Returns the data for this request as a JSON object.
XDocument	getAsXML() Returns the data for this request as a XDocument object, which provides a wrapper around the DOM Document.
protected XDocument	getFinalData() This function will be called once the Java Controller has finsihed so that the final data can be retrieved.
java.lang.String	getPageName() Gets the name of the page that will be displayed once the processing has finished.
void	setPageName(java.lang.String pageName) Set the page to display once the processing has completed.

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestData

public RequestData(XDocument request)

RequestData constructor.

Parameters:

request - The XDocument object containing the initial data this object will manage.

Method Detail

getActionName

public java.lang.String getActionName()

Returns the name of the action that was called from the page.

Returns:

The name of the requested action.

getPageName

public java.lang.String getPageName()

Gets the name of the page that will be displayed once the processing has finished. Use setPageName to change this.

Returns:

The name of the next page.

setPageName

public void setPageName(java.lang.String pageName)

Set the page to display once the processing has completed.

Parameters:

pageName - The name of the page to display.

getAsXML

public XDocument getAsXML()

Returns the data for this request as a XDocument object, which provides a wrapper around the DOM Document.

Use this method if you are happy dealing with the data as XML. Any required changes to the data should be made directly in this XDocument.

Important: Only one of getAsXML and getAsJSON can be used for a given request.

Returns:

The XML data as an XDocument.

getAsJSON

public JSONObject getAsJSON()
                     throws java.io.IOException

Returns the data for this request as a JSON object.

Use this method if you would prefer to deal with the data in a JSON format. Any required changes should be made directly to the returned JSONObject.

Once processing has finished the JSON data will be automatically converted back into XML to enable rendering of the next page.

Note: The XML -> JSON -> XML process can cause changes to the ordering of the data in some situations that you may need to ba aware of. For example, given an initial structure of:

 parent
      item
      item
      another_item
      item
 

the final structure will be

 parent
      item
      item
      item
      another_item
 

due to all the item elements becoming an array in the JSON data. If this is a problem, you should use getAsXML() instead. You could still convert parts of the data to JSON if needed by using the helper methods in JSONUtils.

Important: Only one of getAsXML and getAsJSON can be used for a given request.

Returns:

The data this represents as a JSONObject.

Throws:

java.io.IOException - If an error occurrs during the conversion.

getFinalData

protected XDocument getFinalData()

This function will be called once the Java Controller has finsihed so that the final data can be retrieved. This is protected, as it shouldn't be called from the Java Controller itself.

Returns:

The final data as an XDocument.