creamtec.webcream.core
Class HttpResponseData

java.lang.Object
  creamtec.webcream.core.HttpResponseData

All Implemented Interfaces:

java.io.Serializable

public class HttpResponseData
extends java.lang.Object
implements java.io.Serializable

Contains response parameters, that are sent back to the servlet from the client agent.

See Also:

Serialized Form

Field Summary

static int	STATUS_ERROR
static int	STATUS_EXIT
static int	STATUS_OK

Constructor Summary

HttpResponseData()

Method Summary

java.lang.String	getDownloadFileName() If set, the file is written out into the response
java.lang.String	getErrorMessage() Returns the error message
java.lang.String	getHtmlPage() Returns the HTML page, that needs to be sent to the browser
java.util.HashMap	getParams() Stores WebCream and custom parameters of the response.
java.lang.String	getRedirectURL() Returns the URL of the page, that was requested to be shown next
int	getStatus() Returns the status of the response
java.lang.String	getSubmitURL() Returns the error message
int	getWindowId() Returns the window ID of the window, that was used to render the page
void	setDownloadFileName(java.lang.String fileName) Sets the name of the file to the file is written out into the response for downloading
void	setErrorMessage(java.lang.String message) Sets the error message
void	setHtmlPage(java.lang.String htmlPage) Sets HTMl page of the response
void	setRedirectURL(java.lang.String url) Sets the URL of the page, that was requested to be shown next
void	setStatus(int status)
void	setSubmitURL(java.lang.String url) Sets the error message
void	setWindowId(int id) Sets the window ID, that was used to render the page

Methods inherited from class java.lang.Object

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

Field Detail

STATUS_OK

public static final int STATUS_OK

See Also:

Constant Field Values

STATUS_ERROR

public static final int STATUS_ERROR

See Also:

Constant Field Values

STATUS_EXIT

public static final int STATUS_EXIT

See Also:

Constant Field Values

Constructor Detail

HttpResponseData

public HttpResponseData()

Method Detail

getHtmlPage

public java.lang.String getHtmlPage()
                             throws java.lang.Exception

Returns the HTML page, that needs to be sent to the browser

Throws:

java.lang.Exception

setHtmlPage

public void setHtmlPage(java.lang.String htmlPage)

Sets HTMl page of the response

getWindowId

public int getWindowId()

Returns the window ID of the window, that was used to render the page

getStatus

public int getStatus()

Returns the status of the response

setWindowId

public void setWindowId(int id)

Sets the window ID, that was used to render the page

getRedirectURL

public java.lang.String getRedirectURL()

Returns the URL of the page, that was requested to be shown next

setRedirectURL

public void setRedirectURL(java.lang.String url)

Sets the URL of the page, that was requested to be shown next

getErrorMessage

public java.lang.String getErrorMessage()

Returns the error message

setErrorMessage

public void setErrorMessage(java.lang.String message)

Sets the error message

getSubmitURL

public java.lang.String getSubmitURL()

Returns the error message

setSubmitURL

public void setSubmitURL(java.lang.String url)

Sets the error message

setStatus

public void setStatus(int status)

getParams

public java.util.HashMap getParams()

Stores WebCream and custom parameters of the response. Custom parameters placed into this map should have keys beginning with "custom."

Returns:

HashMap

getDownloadFileName

public java.lang.String getDownloadFileName()

If set, the file is written out into the response

Returns:

String

setDownloadFileName

public void setDownloadFileName(java.lang.String fileName)

Sets the name of the file to the file is written out into the response for downloading

Parameters:

fileName - String