com.ge.research.acuity.web.struts.form
Class AcuityForm

java.lang.Object
  org.apache.struts.action.ActionForm
      com.ge.research.acuity.web.struts.form.AcuityForm

All Implemented Interfaces:

java.io.Serializable

public class AcuityForm

extends org.apache.struts.action.ActionForm

Holds the IndependentDisplayPO objects, along with their PresentationObjectProperties to be displayed by the http client.

Version:

$Revision: 1.1 $ $Date: 2006/08/11 00:17:48 $

Author:

garbiras

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.struts.action.ActionForm

multipartRequestHandler, servlet

Constructor Summary

AcuityForm()
Default Constructor.

Method Summary

void	addErrorObject(IndependentDisplayPO po) Adds an IndependentDisplayPO error message object to the list of presentation object error message objects to be rendered.
void	addMissingPropertyObject(InteractionObject iao) Adds an InteractionObject to the list of "Missing Properties" presentation objects to be rendered.
void	addPresentationObject(IndependentDisplayPO po) Adds an IndependentDisplayPO object to the list of presentation objects to be rendered.
boolean	getCanRemoveVantage() Returns the state of the session with respect to allowing the current vantage to be removed
java.util.List	getClientScriptInformation() Returns the list of client side scripts (and parameter information) to be used to support the current set of presentation objects
IndependentDisplayPO	getErrorObject(int index) Retrieves the IndependentDisplayPO error message object from the presentation object list at the specified index
java.util.List	getErrorObjects() Retrieves the List of IndependentDisplayPO error message objects to be rendered
java.lang.String	getFrameName() Returns the current frame identifier
boolean	getHasFocusVantage() Returns the state of the session with respect to having a vantage established
InteractionObject	getMissingPropertyObject(int index) Retrieves the InteractionObject object from the "Missing Property" presentation object list at the specified index
java.util.List	getMissingPropertyObjects() Retrieves the List of IndependentDisplayPO "Missing Property" objects to be rendered
IndependentDisplayPO	getPresentationObject(int index) Retrieves the IndependentDisplayPO from the presentation object list at the specified index
PresentationObject	getPresentationObject(java.lang.String identifier) Deprecated.
java.util.List	getPresentationObjects() Retrieves the List of IndependentDisplayPO objects to be rendered
java.lang.String	getVantage() Returns the currently selected vantage
void	setCanRemoveVantage(boolean value) Sets the state of the session with respect to allowing the current vantage to be removed
void	setFrameName(java.lang.String frameName) Sets the current frame identifier If frame is null, no changes are applied
void	setHasFocusVantage(boolean value) Sets the state of the session with respect to having a vantage established
void	setRequiredScripts(java.lang.String[] scripts)
void	setVantage(java.lang.String vantage) Sets the currently selected vantage If vantage is null, no changes are applied

Methods inherited from class org.apache.struts.action.ActionForm

getMultipartRequestHandler, getServlet, getServletWrapper, reset, reset, setMultipartRequestHandler, setServlet, validate, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

AcuityForm

public AcuityForm()

Default Constructor. Sets up the script references to those default client scripts needed by the framework

Method Detail

setRequiredScripts

public void setRequiredScripts(java.lang.String[] scripts)

getCanRemoveVantage

public boolean getCanRemoveVantage()

Returns the state of the session with respect to allowing the current vantage to be removed

Returns:

true if the vantage can be removed; false otherwise

getHasFocusVantage

public boolean getHasFocusVantage()

Returns the state of the session with respect to having a vantage established

Returns:

true if a vantage is currently established; false otherwise

getPresentationObject

public IndependentDisplayPO getPresentationObject(int index)

Retrieves the IndependentDisplayPO from the presentation object list at the specified index

Parameters:

index - the index of presentation object list to extract

Returns:

the presentation object at the specified index

getPresentationObjects

public java.util.List getPresentationObjects()

Retrieves the List of IndependentDisplayPO objects to be rendered

Returns:

List of IndependentDisplayPO objects

addPresentationObject

public void addPresentationObject(IndependentDisplayPO po)

Adds an IndependentDisplayPO object to the list of presentation objects to be rendered. Adds any client side scripts used by this PO (or nested contents) to the list of scripts the client needs to use.

Parameters:

po - the presentation object to add to the list

See Also:

com.ge.research.acuity.struts.form.AcuityForm#addScripts(com.ge.research.acuity.ui.PresentationObject)

getErrorObject

public IndependentDisplayPO getErrorObject(int index)

Retrieves the IndependentDisplayPO error message object from the presentation object list at the specified index

Parameters:

index - the index of presentation object error message object list to extract

Returns:

the presentation object error message object at the specified index

getErrorObjects

public java.util.List getErrorObjects()

Retrieves the List of IndependentDisplayPO error message objects to be rendered

Returns:

List of IndependentDisplayPO error message objects

addErrorObject

public void addErrorObject(IndependentDisplayPO po)

Adds an IndependentDisplayPO error message object to the list of presentation object error message objects to be rendered.

Parameters:

po - the presentation object error message object to add to the list

getMissingPropertyObject

public InteractionObject getMissingPropertyObject(int index)

Retrieves the InteractionObject object from the "Missing Property" presentation object list at the specified index

Parameters:

index - the index of "missing property" presentation object list to extract

Returns:

the "missing property" presentation object at the specified index

getMissingPropertyObjects

public java.util.List getMissingPropertyObjects()

Retrieves the List of IndependentDisplayPO "Missing Property" objects to be rendered

Returns:

List of "missing property" IndependentDisplayPO objects

addMissingPropertyObject

public void addMissingPropertyObject(InteractionObject iao)

Adds an InteractionObject to the list of "Missing Properties" presentation objects to be rendered.

Parameters:

iao - the "missing property" presentation object to add to the list

setCanRemoveVantage

public void setCanRemoveVantage(boolean value)

Sets the state of the session with respect to allowing the current vantage to be removed

Parameters:

value - true if the vantage can be removed; false otherwise

setHasFocusVantage

public void setHasFocusVantage(boolean value)

Sets the state of the session with respect to having a vantage established

Parameters:

value - true if a vantage is currently established; false otherwise

getFrameName

public java.lang.String getFrameName()

Returns the current frame identifier

Returns:

The current frame identifier

setFrameName

public void setFrameName(java.lang.String frameName)

Sets the current frame identifier If frame is null, no changes are applied

Parameters:

frameName - the current frame identifier

getVantage

public java.lang.String getVantage()

Returns the currently selected vantage

Returns:

The currently selected vantage

setVantage

public void setVantage(java.lang.String vantage)

Sets the currently selected vantage If vantage is null, no changes are applied

Parameters:

vantage - the currently selected vantage

getPresentationObject

public PresentationObject getPresentationObject(java.lang.String identifier)

Deprecated.

TO BE REMOVED:

This method is only used by the com.ge.research.acuity.struts.action.TestServerGraphingAction class which is a test class When that class is no longer used and removed from the source this method should also be eliminated

getClientScriptInformation

public java.util.List getClientScriptInformation()

Returns the list of client side scripts (and parameter information) to be used to support the current set of presentation objects

Returns:

A list of client side script import information