psdi.webclient.system.controller

Class WebClientEvent

java.lang.Object

psdi.webclient.system.controller.WebClientEvent

public class WebClientEvent
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	additionalEvent
protected java.lang.String	additionalEventValue
static int	CANCEL_EVENT
static int	ERROR_CHECKED_APP
static int	ERROR_CHECKED_NONE
static int	ERROR_CHECKED_PAGE
protected int	messageReturn
protected java.util.Hashtable	params
static int	PROCESS_EVENT
protected boolean	processed
protected boolean	render
protected int	row
protected ComponentInstance	sourceComponentInstance
protected ControlInstance	sourceControlInstance
protected int	status
protected java.lang.String	targetId
protected java.lang.Object	transformedValue Contains the transformed value for this event.
protected java.lang.String	type
protected long	uniqueid
protected java.lang.Object	value
protected WebClientSession	webClientSession

Constructor Summary

Constructors

Constructor and Description
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, SessionContext sessionContext) Deprecated. FIREFOX
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, java.lang.String row, java.lang.String additionalEvent, long uniqueid, SessionContext sessionContext) Deprecated. FIREFOX
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, java.lang.String row, java.lang.String additionalEvent, long uniqueid, WebClientSession wcs)
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, java.lang.String row, java.lang.String additionalEvent, java.lang.String additionalEventValue, long uniqueid, WebClientSession wcs)
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, java.lang.String row, java.lang.String additionalEvent, java.lang.String additionalEventValue, long uniqueid, WebClientSession wcs, BaseInstance creatingInstance)
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, java.lang.String row, WebClientSession wcs)
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, WebClientSession wcs)
WebClientEvent(java.lang.String type, java.lang.String targetId, java.lang.Object value, WebClientSession wcs, ComponentInstance source) Use this constructor to create an event and force it's source component and control

Method Summary

Modifier and Type	Method and Description
void	addParameter(java.lang.Object key, java.lang.Object value)
void	cancelRender()
boolean	canRender()
boolean	conditionalReqChecked() Returns true if conditionally required fields have already been checked for this event.
java.lang.String	getAdditionalEvent()
java.lang.String	getAdditionalEventValue()
java.util.Map	getEventMap()
int	getEventStatus()
int	getLevelCheckedForErrors() Returns the if the aysnc errors were check on the current page (if a dialog) or were checked on the app level.
int	getMessageReturn()
java.lang.String	getMessageReturnId()
java.lang.Object	getParameter(java.lang.Object key) get a parameter from this event.
java.util.Hashtable	getParameters()
java.lang.String	getRequestType()
int	getRow()
SessionContext	getSessionContext() Deprecated. FIREFOX
ComponentInstance	getSourceComponentInstance()
ControlHandler	getSourceControl() Deprecated. FIREFOX
ControlInstance	getSourceControlInstance() Returns the ControlHandler that created the event
java.lang.String	getTargetId()
java.lang.Object	getTransformedValue()
java.lang.String	getType()
long	getUniqueId()
java.lang.Object	getValue()
java.lang.String	getValueString()
WebClientSession	getWebClientSession() Get the WebClientSession from the event
boolean	hasTransformedValue()
boolean	isClientEvent() Returns if this event came from the client.
boolean	isPassedSigCheck()
void	setAdditionalEvent(java.lang.String event)
void	setAdditionalEventValue(java.lang.String eventValue)
void	setClientEvent(boolean clientEvent)
void	setConditionalReqChecked(boolean conditionalReqChecked)
void	setEventMap(java.util.Map eventMap)
void	setLevelCheckedForErrors(int level) Sets the what level the async errors were checked; page (ERROR_CHECKED_PAGE) or app (ERROR_CHECKED_APP).
void	setMessageReturn(int msgReturn)
void	setMessageReturnId(java.lang.String msgReturnId)
void	setPassedSigCheck(boolean passedSigCheck)
void	setProcessed()
void	setRequestType(java.lang.String requestType)
void	setRow(int row)
void	setSourceComponent(ComponentInstance sourceComponent)
void	setSourceControl(ControlHandler sourceControl) Deprecated. FIREFOX
void	setSourceControl(ControlInstance sourceControl) Overrides ControlInstance that created the event.
void	setStatus(int eventStatus)
void	setTransformedValue(java.lang.Object transformedValue)
void	setValue(java.lang.Object eventvalue)
java.lang.String	toString()
boolean	wasProcessed()

Methods inherited from class java.lang.Object

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

Field Detail

PROCESS_EVENT

public static final int PROCESS_EVENT

See Also:

Constant Field Values

CANCEL_EVENT

public static final int CANCEL_EVENT

See Also:

Constant Field Values

ERROR_CHECKED_NONE

public static final int ERROR_CHECKED_NONE

See Also:

Constant Field Values

ERROR_CHECKED_PAGE

public static final int ERROR_CHECKED_PAGE

See Also:

Constant Field Values

ERROR_CHECKED_APP

public static final int ERROR_CHECKED_APP

See Also:

Constant Field Values

type

protected java.lang.String type

targetId

protected java.lang.String targetId

value

protected java.lang.Object value

row

protected int row

status

protected int status

params

protected java.util.Hashtable params

messageReturn

protected int messageReturn

processed

protected boolean processed

sourceControlInstance

protected ControlInstance sourceControlInstance

sourceComponentInstance

protected ComponentInstance sourceComponentInstance

additionalEvent

protected java.lang.String additionalEvent

uniqueid

protected long uniqueid

additionalEventValue

protected java.lang.String additionalEventValue

webClientSession

protected WebClientSession webClientSession

render

protected boolean render

transformedValue

protected java.lang.Object transformedValue

Contains the transformed value for this event. When a launch in context is performed, the value is transformed and set in this event. The original value is still available in case it is needed.

Constructor Detail

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      WebClientSession wcs)

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      java.lang.String row,
                      WebClientSession wcs)

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      java.lang.String row,
                      java.lang.String additionalEvent,
                      long uniqueid,
                      WebClientSession wcs)

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      java.lang.String row,
                      java.lang.String additionalEvent,
                      java.lang.String additionalEventValue,
                      long uniqueid,
                      WebClientSession wcs)

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      java.lang.String row,
                      java.lang.String additionalEvent,
                      java.lang.String additionalEventValue,
                      long uniqueid,
                      WebClientSession wcs,
                      BaseInstance creatingInstance)

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      WebClientSession wcs,
                      ComponentInstance source)

Use this constructor to create an event and force it's source component and control

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      SessionContext sessionContext)

Deprecated. FIREFOX

WebClientEvent

public WebClientEvent(java.lang.String type,
                      java.lang.String targetId,
                      java.lang.Object value,
                      java.lang.String row,
                      java.lang.String additionalEvent,
                      long uniqueid,
                      SessionContext sessionContext)

Deprecated. FIREFOX

Method Detail

getSourceControlInstance

public ControlInstance getSourceControlInstance()

Returns the ControlHandler that created the event

Returns:

getSourceControl

public ControlHandler getSourceControl()

Deprecated. FIREFOX

See Also:

WebClientEvent.getSourceControlInstance()

setSourceControl

public void setSourceControl(ControlInstance sourceControl)

Overrides ControlInstance that created the event.

setSourceControl

public void setSourceControl(ControlHandler sourceControl)

Deprecated. FIREFOX

See Also:

WebClientEvent.setSourceControl(psdi.webclient.system.controller.ControlInstance)

getSourceComponentInstance

public ComponentInstance getSourceComponentInstance()

setSourceComponent

public void setSourceComponent(ComponentInstance sourceComponent)

getType

public java.lang.String getType()

getTargetId

public java.lang.String getTargetId()

getValue

public java.lang.Object getValue()

getRow

public int getRow()

getValueString

public java.lang.String getValueString()

setValue

public void setValue(java.lang.Object eventvalue)

getEventStatus

public int getEventStatus()

setStatus

public void setStatus(int eventStatus)

addParameter

public void addParameter(java.lang.Object key,
                         java.lang.Object value)

getParameters

public java.util.Hashtable getParameters()

getWebClientSession

public WebClientSession getWebClientSession()

Get the WebClientSession from the event

getMessageReturn

public int getMessageReturn()

setMessageReturn

public void setMessageReturn(int msgReturn)

getMessageReturnId

public java.lang.String getMessageReturnId()

setMessageReturnId

public void setMessageReturnId(java.lang.String msgReturnId)

wasProcessed

public boolean wasProcessed()

Returns:

setProcessed

public void setProcessed()

Parameters:

b -

getAdditionalEvent

public java.lang.String getAdditionalEvent()

Returns:

getUniqueId

public long getUniqueId()

Returns:

getAdditionalEventValue

public java.lang.String getAdditionalEventValue()

setRow

public void setRow(int row)

getSessionContext

public SessionContext getSessionContext()

Deprecated. FIREFOX

See Also:

WebClientEvent.getWebClientSession()

cancelRender

public void cancelRender()

canRender

public boolean canRender()

isPassedSigCheck

public boolean isPassedSigCheck()

setPassedSigCheck

public void setPassedSigCheck(boolean passedSigCheck)

setAdditionalEventValue

public void setAdditionalEventValue(java.lang.String eventValue)

setAdditionalEvent

public void setAdditionalEvent(java.lang.String event)

setTransformedValue

public void setTransformedValue(java.lang.Object transformedValue)

getTransformedValue

public java.lang.Object getTransformedValue()

hasTransformedValue

public boolean hasTransformedValue()

getParameter

public java.lang.Object getParameter(java.lang.Object key)

get a parameter from this event.

Parameters:

key -

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLevelCheckedForErrors

public int getLevelCheckedForErrors()

Returns the if the aysnc errors were check on the current page (if a dialog) or were checked on the app level.

Returns:

ERROR_CHECKED_PAGE if checked on the page level, ERROR_CHECKED_APP if on the app level

setLevelCheckedForErrors

public void setLevelCheckedForErrors(int level)

Sets the what level the async errors were checked; page (ERROR_CHECKED_PAGE) or app (ERROR_CHECKED_APP).

Parameters:

errorsChecked - the errorsChecked to set

conditionalReqChecked

public boolean conditionalReqChecked()

Returns true if conditionally required fields have already been checked for this event. (If

Returns:

the conditionalReqChecked

setConditionalReqChecked

public void setConditionalReqChecked(boolean conditionalReqChecked)

Parameters:

conditionalReqChecked - the conditionalReqChecked to set

getRequestType

public java.lang.String getRequestType()

Returns:

requestType

setRequestType

public void setRequestType(java.lang.String requestType)

Parameters:

requestType - the requestType to set

getEventMap

public java.util.Map getEventMap()

Returns:

eventMap the eventMap from client side queued JSONArray

setEventMap

public void setEventMap(java.util.Map eventMap)

Parameters:

eventMap - the eventMap from client side queued JSONArray to set

isClientEvent

public boolean isClientEvent()

Returns if this event came from the client.

setClientEvent

public void setClientEvent(boolean clientEvent)

Parameters:

clientEvent - true if the event came from the client. false if not.