oracle.adf.view.page.editor.event

Class SaveEvent

java.lang.Object

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

oracle.adf.view.page.editor.event.SaveEvent

public class SaveEvent
extends PageEditorEvent

A SaveEvent is a notification that the Save button on Oracle Composer has been clicked by the end user.

SaveEvent is used to notify component property edits as well as page commits or updates. This class has a constructor which takes a parameter isCommit. Set this parameter to true if you are creating a SaveEvent for page commits or updates and set it to false for component property edits.

Since:

11.1.1.0.1BETA

Constructor Summary

Constructors

Constructor and Description
SaveEvent() Default no-op constructor to be used to create SaveEvent for component property edits
SaveEvent(boolean isCommit) Overloaded constructor to be used for creating save event in sandboxed MDS interactions, when the page is being marked for persisting the customizations at the end of current request lifecycle

Method Summary

Modifier and Type	Method and Description
Event	getEventType() Returns the type of this event.
boolean	isCommit() Returns true if this event was created to indicate that the page was marked to commit the customizations done to the page at the end of the current request lifecycle.
void	processListener(PageEditorListener listener) Broadcast this SaveEvent to the specified PageEditorListener, by whatever mechanism is appropriate.

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

isEventHandled, setEventHandled

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveEvent

public SaveEvent()

Default no-op constructor to be used to create SaveEvent for component property edits

SaveEvent

public SaveEvent(boolean isCommit)

Overloaded constructor to be used for creating save event in sandboxed MDS interactions, when the page is being marked for persisting the customizations at the end of current request lifecycle

Parameters:

isCommit - set this to true to indicate page commit

Method Detail

processListener

public void processListener(PageEditorListener listener)
                     throws javax.faces.event.AbortProcessingException

Broadcast this SaveEvent to the specified PageEditorListener, by whatever mechanism is appropriate. This is accomplished by calling processSave method on SaveListener, and passing this SaveEvent as a paramter.

Specified by:

processListener in class PageEditorEvent

Parameters:

listener - PageEditorListener to send this SaveEvent to.

Throws:

javax.faces.event.AbortProcessingException - Signal Oracle Composer that no further processing on the current event should be performed.

getEventType

public final Event getEventType()

Returns the type of this event.

Specified by:

getEventType in class PageEditorEvent

Returns:

Returns Event.SAVE_EVENT.

isCommit

public boolean isCommit()

Returns true if this event was created to indicate that the page was marked to commit the customizations done to the page at the end of the current request lifecycle. It returns false if the event was created to indicate property edit commits done through the property inspector.

Returns:

true if page was marked to commit customizations, false otherwise