oracle.adf.view.page.editor.event

Class BaseGenericActionEvent

java.lang.Object

oracle.adf.view.page.editor.event.PageEditorEvent

oracle.adf.view.page.editor.event.PageEditorEventWithResult

oracle.adf.view.page.editor.event.BaseGenericActionEvent

Direct Known Subclasses:

GenericActionEvent

public abstract class BaseGenericActionEvent
extends PageEditorEventWithResult

A BaseGenericActionEvent is a notification about an action that has executed during runtime

Constructor Summary

Constructors

Constructor and Description
BaseGenericActionEvent(java.util.Map<java.lang.String,java.lang.Object> map) Constructor

Method Summary

Modifier and Type	Method and Description
abstract Action	getAction() returns the action
java.lang.String	getMessageDetail() Returns the detail message
javax.faces.application.FacesMessage.Severity	getMessageSeverity() Returns the message severity
java.lang.String	getMessageSummary() Returns the message summary
java.util.Map<java.lang.String,java.lang.Object>	getPayload() get the payload of the event
abstract void	setAction(Action action) set the action for which the event was raised
void	setMessageDetail(java.lang.String msgDetail) Set the message detail
void	setMessageSeverity(javax.faces.application.FacesMessage.Severity severity) Set the message severity
void	setMessageSummary(java.lang.String msgSummary) Set the message summary
void	setShowMessage(boolean showMsg) Set the flag which indicates if to show message when no error
boolean	showMessage() If to show message when no error

Methods inherited from class oracle.adf.view.page.editor.event.PageEditorEventWithResult

processListener

Methods inherited from class oracle.adf.view.page.editor.event.PageEditorEvent

getEventType, isEventHandled, processListener, setEventHandled

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseGenericActionEvent

public BaseGenericActionEvent(java.util.Map<java.lang.String,java.lang.Object> map)

Constructor

Parameters:

map - Map of the event payload

Method Detail

setAction

public abstract void setAction(Action action)

set the action for which the event was raised

Parameters:

action - action type

getAction

public abstract Action getAction()

returns the action

Returns:

setMessageDetail

public void setMessageDetail(java.lang.String msgDetail)

Set the message detail

Parameters:

msgDetail - the detail message

getMessageDetail

public java.lang.String getMessageDetail()

Returns the detail message

Returns:

the detail message

setMessageSummary

public void setMessageSummary(java.lang.String msgSummary)

Set the message summary

Parameters:

msgSummary - the summary message

getMessageSummary

public java.lang.String getMessageSummary()

Returns the message summary

Returns:

the message summary

setMessageSeverity

public void setMessageSeverity(javax.faces.application.FacesMessage.Severity severity)

Set the message severity

Parameters:

severity - the error message severity

getMessageSeverity

public javax.faces.application.FacesMessage.Severity getMessageSeverity()

Returns the message severity

Returns:

the error message severity

setShowMessage

public void setShowMessage(boolean showMsg)

Set the flag which indicates if to show message when no error

Parameters:

showMsg - the flag which indicates if to show message when no error

showMessage

public boolean showMessage()

If to show message when no error

Returns:

true if to show the message when error; otherwise false

getPayload

public java.util.Map<java.lang.String,java.lang.Object> getPayload()

get the payload of the event

Returns:

Map of the payload