de.spieleck.pcs.action
Class ActionResult

java.lang.Object
  |
  +--de.spieleck.pcs.action.ActionResult

public class ActionResult

extends java.lang.Object

This class represents the result of a performed Action. An ActionResult consists of an XML representation and additional properties carried in a Hashtable

See Also:

Action

Constructor Summary

ActionResult()
Creates a new instance of ActionResult

ActionResult(javax.xml.transform.Source source, java.util.Hashtable parameters)
creates an ActionResult with the given values

ActionResult(javax.xml.transform.Source source, java.util.Hashtable parameters, java.lang.String styleSheet)
creates an ActionResult with the given values

ActionResult(java.lang.String xml, java.util.Hashtable parameters)
Creates an instance of ActionResult with the given properties

ActionResult(java.lang.String xml, java.util.Hashtable parameters, java.lang.String styleSheet)
creates an ActionResult with the given values

Method Summary

java.util.Hashtable	getParameters() returns the parameters of this ActionResult as a Hashtable
javax.xml.transform.Source	getSource() Getter for property source.
java.lang.String	getStyleSheet() returns the name of the stylesheet to be used with this ActionResult, can be used for variable stylesheets (e.g. display the Results in a table overview or in detail) and to overwrite the stylesheet setting of the service
java.lang.String	getXml() Deprecated. use getSource() instead
void	setParameters(java.util.Hashtable parameters) sets the parameters of this ActionResult
void	setSource(javax.xml.transform.Source source) Setter for property source.
void	setStyleSheet(java.lang.String styleSheet) sets the name of the stylesheet to be used with this ActionResult
void	setXml(java.lang.String xml) convenience method for setting the ActionResult's XML data with an StreamSource using the given String as input

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionResult

public ActionResult()

Creates a new instance of ActionResult

ActionResult

public ActionResult(java.lang.String xml,
                    java.util.Hashtable parameters)

Creates an instance of ActionResult with the given properties

Parameters:

xml - a XML-Source representing the ActionResult

parameters - the additional parameters of the ActionResult as a Hashtable

styleSheetKey - key to lookup stylesheet for transformation

ActionResult

public ActionResult(java.lang.String xml,
                    java.util.Hashtable parameters,
                    java.lang.String styleSheet)

creates an ActionResult with the given values

ActionResult

public ActionResult(javax.xml.transform.Source source,
                    java.util.Hashtable parameters)

creates an ActionResult with the given values

ActionResult

public ActionResult(javax.xml.transform.Source source,
                    java.util.Hashtable parameters,
                    java.lang.String styleSheet)

creates an ActionResult with the given values

Method Detail

setXml

public void setXml(java.lang.String xml)

convenience method for setting the ActionResult's XML data with an StreamSource using the given String as input

Since:

1.1

getXml

public java.lang.String getXml()

Deprecated. use getSource() instead

returns the xml data of the ActionResult as a String

Since:

1.1

getParameters

public java.util.Hashtable getParameters()

returns the parameters of this ActionResult as a Hashtable

setParameters

public void setParameters(java.util.Hashtable parameters)

sets the parameters of this ActionResult

getSource

public javax.xml.transform.Source getSource()

Getter for property source.

Returns:

Value of property source.

setSource

public void setSource(javax.xml.transform.Source source)

Setter for property source.

Parameters:

source - New value of property source.

getStyleSheet

public java.lang.String getStyleSheet()

returns the name of the stylesheet to be used with this ActionResult, can be used for variable stylesheets (e.g. display the Results in a table overview or in detail) and to overwrite the stylesheet setting of the service

Returns:

Value of property styleSheet.

See Also:

de.spieleck.pcs.http.Service, View

setStyleSheet

public void setStyleSheet(java.lang.String styleSheet)

sets the name of the stylesheet to be used with this ActionResult

Parameters:

styleSheet - New value of property styleSheet.