com.ge.research.acuity.ui
Class InteractionObject

java.lang.Object
  com.ge.research.acuity.ui.PresentationObject
      com.ge.research.acuity.ui.IndependentDisplayPO
          com.ge.research.acuity.ui.InteractionObject

Direct Known Subclasses:

SelectionPO, TextEntryPO

public class InteractionObject

extends IndependentDisplayPO

A presentation object that allows for interaction with a user in a client application. Interaction objects present a prompt explaining the purpose of the interaction mechanism, whether it be to select from a choice of alternatives, to enter free text information, or to trigger an action to occur.

Version:

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

Author:

garbiras

Field Summary

static java.lang.String	CLIENT_EFFECT_LANGUAGE The client side effect Map keyword identifying the language of a clide side effect
static java.lang.String	CLIENT_EFFECT_LOCATION The client side effect Map keyword identifying the source of a clide side effect
static java.lang.String	CLIENT_EFFECT_TYPE The client side effect Map keyword identifying the type of a clide side effect

Constructor Summary

InteractionObject()
Calls the default constructor with null argument

InteractionObject(java.lang.String prompt)
The default constructor.

Method Summary

boolean	alwaysRefresh() Returns the value of the always refresh flag for this interaction object.
java.util.Map	getClientEffects() Returns any information about client side scripts associated with this interaction object.
int	getOrientation() Returns the layout orientation of the interaction object.
java.lang.String	getPrompt() Returns the explanatory prompt of the purpose for the interaction object
java.lang.String	getValueName() Returns the value name anchor identifier for this interaction object
boolean	hasOwnSubmit() Returns the value of the hasOwnSubmit flag.
boolean	isDisabled() Returns the value of the disabled flag for this interaction object.
void	setAlwaysRefresh(boolean b) Sets the value of the always refresh flag for this interaction object.
void	setClientEffects(java.util.Map effects) Sets any information about client side scripts associated with this interaction object.
void	setHasOwnSubmit(boolean b) Sets the value of the hasOwnSubmit flag.
void	setHasPresentationNature(java.lang.String string) Overrides setHasPresentationNature in PresentationObject.
void	setIsDisabled(boolean b) Sets the value of the disabled flag for this interaction object.
void	setOrientation(int i) Sets the layout orientation of the interaction object.
void	setPrompt(java.lang.String string) Sets the explanatory prompt displayed to the user with the interaction component, offering insight and meaning to the purpose for the interaction object
void	setSubmitsOnChange(boolean b) Sets the value of the flag indicating whether or not this interacttion object communicates its value immediately upon a value change.
void	setValueName(java.lang.String string) Sets the value name anchor identifier for this interaction object
boolean	submitsOnChange() Returns the value of the flag indicating whether or not this interaction object communicates its value immediately upon a value change.

Methods inherited from class com.ge.research.acuity.ui.IndependentDisplayPO

canBeRemoved, displayBanner, getHeight, getIdentifierTitle, getWidth, getXPos, getYPos, getZOrder, setCanBeRemoved, setDisplayBanner, setHeight, setIdentifier, setIdentifierTitle, setPos, setPos, setPos, setPos, setWidth, setXPos, setYPos, setZOrder

Methods inherited from class com.ge.research.acuity.ui.PresentationObject

addLookupInfo, getHasPresentationNature, getIdentifier, getLookupInfo, getSubject, hasSubject, isDisplayed, isEditable, setEditability, setIsDisplayed

Methods inherited from class java.lang.Object

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

Field Detail

CLIENT_EFFECT_LOCATION

public static final java.lang.String CLIENT_EFFECT_LOCATION

The client side effect Map keyword identifying the source of a clide side effect

See Also:

Constant Field Values

CLIENT_EFFECT_TYPE

public static final java.lang.String CLIENT_EFFECT_TYPE

The client side effect Map keyword identifying the type of a clide side effect

See Also:

Constant Field Values

CLIENT_EFFECT_LANGUAGE

public static final java.lang.String CLIENT_EFFECT_LANGUAGE

The client side effect Map keyword identifying the language of a clide side effect

See Also:

Constant Field Values

Constructor Detail

InteractionObject

public InteractionObject()

Calls the default constructor with null argument

InteractionObject

public InteractionObject(java.lang.String prompt)

The default constructor. Calls super(). Sets the interaction content statement. Sets the presentation nature to PresentationNatureConstants.HIDDEN

Parameters:

prompt - the prompt explaining the purpose of this interaction object and content

See Also:

PresentationObject.PresentationObject(), setPrompt(java.lang.String), PresentationObject.setHasPresentationNature(java.lang.String)

Method Detail

alwaysRefresh

public final boolean alwaysRefresh()

Returns the value of the always refresh flag for this interaction object.

Returns:

true if this interaction object's content should be refreshed on every client update; false if this interaction object's content should only be refreshed when the system deems necessary.

getOrientation

public final int getOrientation()

Returns the layout orientation of the interaction object. The layout orientation determines if the interaction object prompt, interaction component, and update trigger mechanism are rendered in a horizontal or vertical fashion. The orientation value is one of either PresentationParameterConstants.IAO_ORIENTATION_HORIZONTAL or PresentationParameterConstants.IAO_ORIENTATION_VERTICAL

Returns:

The layout orientation of the interaction object

getPrompt

public final java.lang.String getPrompt()

Returns the explanatory prompt of the purpose for the interaction object

Returns:

The interaction object prompt

getValueName

public final java.lang.String getValueName()

Returns the value name anchor identifier for this interaction object

Returns:

The value name anchor identifier for this interaction object

hasOwnSubmit

public final boolean hasOwnSubmit()

Returns the value of the hasOwnSubmit flag.

Returns:

true if this interaction object, when rendered, should have its own update trigger mechanism (submit button); false if this interaction object, when rendered, should not have its own update trigger mechanism (submit button).

getClientEffects

public final java.util.Map getClientEffects()

Returns any information about client side scripts associated with this interaction object. The Map is of the format: keys are the ontology Individual URI of the script associated with the interaction object; the values are a Map of script parameters and their values.

Returns:

A Map structure of associated client side scripts and their parameters, or null if there are no associated effects.

isDisabled

public final boolean isDisabled()

Returns the value of the disabled flag for this interaction object.

Returns:

true if this presentation object cannot be interacted within a client application by a user; false if this presentation object can be interacted within a client application by a user.

setAlwaysRefresh

public final void setAlwaysRefresh(boolean b)

Sets the value of the always refresh flag for this interaction object.

Parameters:

b - true if this interaction object's content should be refreshed on every client update; false if this interaction object's content should only be refreshed when the system deems necessary.

setHasOwnSubmit

public final void setHasOwnSubmit(boolean b)

Sets the value of the hasOwnSubmit flag.

Parameters:

b - true if this interaction object, when rendered, should have its own update trigger mechanism (submit button); false if this interaction object, when rendered, should not have its own update trigger mechanism (submit button).

setClientEffects

public final void setClientEffects(java.util.Map effects)

Sets any information about client side scripts associated with this interaction object. The Map is of the format: keys are the ontology Individual URI of the script associated with the interaction object; the values are a Map of script parameters and their values.

Parameters:

effects - a Map structure of associated client side scripts and their parameters, or null if there are no associated effects.

setHasPresentationNature

public void setHasPresentationNature(java.lang.String string)

Overrides setHasPresentationNature in PresentationObject. Checks that the new value for presentation nature is a valid type for an interaction object. If not, the value of presentation nature does not change.

Overrides:

setHasPresentationNature in class PresentationObject

Parameters:

string - the new value of presentation nature

See Also:

PresentationNatureConstants.isInteractionType(java.lang.String)

setIsDisabled

public final void setIsDisabled(boolean b)

Sets the value of the disabled flag for this interaction object.

Parameters:

b - true if this presentation object cannot be interacted with in a client application by a user; false if this presentation object can be interacted with in a client application by a user.

setOrientation

public final void setOrientation(int i)

Sets the layout orientation of the interaction object. If i is not one of either PresentationParameterConstants.IAO_ORIENTATION_HORIZONTAL or PresentationParameterConstants.IAO_ORIENTATION_VERTICAL

Parameters:

i - the new layout orientation for the interaction object

See Also:

PresentationParameterConstants.IAO_ORIENTATION_HORIZONTAL, PresentationParameterConstants.IAO_ORIENTATION_VERTICAL

setPrompt

public final void setPrompt(java.lang.String string)

Sets the explanatory prompt displayed to the user with the interaction component, offering insight and meaning to the purpose for the interaction object

Parameters:

string - the interaction object prompt

setSubmitsOnChange

public final void setSubmitsOnChange(boolean b)

Sets the value of the flag indicating whether or not this interacttion object communicates its value immediately upon a value change.

Parameters:

b - true if the object should communicate the value immediately upon change; false if the object should use another trigger to communicate the value.

setValueName

public final void setValueName(java.lang.String string)

Sets the value name anchor identifier for this interaction object

Parameters:

string - the value name anchor identifier for this interaction object

submitsOnChange

public final boolean submitsOnChange()

Returns the value of the flag indicating whether or not this interaction object communicates its value immediately upon a value change.

Returns:

true if the object communicates the value immediately upon change; false if the object uses another trigger to communicate the value.