oracle.dss.thin.beans.dataView
Class SaveConfirmation

java.lang.Object
  |
  +--oracle.dss.thin.beans.BaseThinBeanUI
        |
        +--oracle.dss.thin.beans.ThinBeanDialog
              |
              +--oracle.dss.thin.beans.dataView.SaveAs
                    |
                    +--oracle.dss.thin.beans.dataView.SaveConfirmation

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI

public class SaveConfirmation

extends SaveAs

The ThinBeanUI for the Save Confirmation dialog. The Save Confirmation dialog is used to:

• Confirm that a user wants to save changes in a thin presentation bean -- In this case, the SaveConfirmation is generally invoked from a Save button or link that appears on the same page as a thin presentation bean. The button or link sends a BIConstants.INIT_EVENT to the SaveConfirmation.
• Confirm that a user wants to overwrite an existing object in the BI Beans Catalog -- In this case, the thin presentation bean that is performing the save operation calls the saveConfirmationRequested method of the registered ThinViewListener, which you should implement and register. In your implementation of the SaveConfirmationRequested method, initialize the SaveConfirmation.

The appearance of the dialog depends on the value of the Overwrite property of this SaveConfirmation. In either case, the SaveConfirmation generates a BIConstants.SAVE_EVENT, which is handled by the thin presentation bean. The thin presentation bean actually performs the save operation.

The SaveConfirmation generates the following events:

• BIConstants.SAVE_EVENT -- Pass this event to the generateOnClickSubmit method to get Javascript that generates this event. Set the return value as the ON_CLICK_ATTR of the UIX button or link, to provide OK navigation for this SaveConfirmation. Set an EventTarget to direct this event to the thin presentation bean that is being saved.
• BIConstants.CANCEL_EVENT Pass this event to the generateOnClickSubmit method to get Javascript that generates this event. Set the return value as the ON_CLICK_ATTR of the UIX button or link, to provide Cancel navigation for this SaveConfirmation. Set an EventTarget to direct this event to the application page to navigate to when users choose Cancel.

The SaveConfirmation handles the following event:

• BIConstants.INIT_EVENT -- This dialog handles this event only when it is used for saving a view in place. It handles the event by sending an InitEvent to any registered listeners. The event is generated by the InitEventDataObject that you set on the button or hyperlink that you create to invoke this ThinDialog.

  When the view invokes this dialog to confirm the saving of the view over an existing object, the view calls the saveConfirmationRequested method of the registered ThinViewListener.

For more information about using the Save Confirmation dialog, see the "Save Confirmation Dialog" topic in the BI Beans Help system.

See Also:

ThinDataviewCommon, InitEventDataObject

Fields inherited from class oracle.dss.thin.beans.ThinBeanDialog

ALL_PAGES, CURRENT_PAGE, SELECTED_PAGES

Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary

SaveConfirmation()
Constructor.

Method Summary

void	init(QueryParameterProvider provider) Initializes this SaveConfirmation.
boolean	isOverwrite() Indicates whether this SaveConfirmation will ask if the user wants to overwrite an existing view.
void	setOverwrite(boolean overwrite) Specifies whether this SaveConfirmation should ask if the user wants to overwrite an existing view.

Methods inherited from class oracle.dss.thin.beans.dataView.SaveAs

getDescription, getFormName, getFrameName, getKeywords, getLocation, getName, getRootName, handleEvent, setDescription, setFormName, setFrameName, setKeywords, setLocation, setName, setRootName

Methods inherited from class oracle.dss.thin.beans.ThinBeanDialog

addThinBeanDialogListener, removeThinBeanDialogListener

Methods inherited from class oracle.dss.thin.beans.BaseThinBeanUI

addErrorHandler, checkpointState, generateOnClickSubmit, getCheckpointState, getEventTarget, getLocale, getState, getThinBeanName, removeErrorHandler, setBaseState, setCheckpointState, setEventTarget, setLocale, setState, setThinBeanName

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveConfirmation

public SaveConfirmation()

Constructor.

Method Detail

init

public void init(QueryParameterProvider provider)

Initializes this SaveConfirmation. This method initializes this object with the information that is needed to render the confirmation page. Call this method from the saveConfirmationRequested method in a ThinViewListener, to display this SaveConfirmation in the case where the user has tried to save an view over an object of the same name.

Before you call this method, set the Overwrite property to true, and set an event target on the SAVE_EVENT to the view that is being saved.

Parameters:

provider - The parameter provider from the Java SaveEvent that is passed to the listener.

See Also:

setOverwrite(boolean), EventTarget, ThinViewListener, ThinDataviewCommon, BIConstants.SAVE_EVENT

setOverwrite

public void setOverwrite(boolean overwrite)

Specifies whether this SaveConfirmation should ask if the user wants to overwrite an existing view. The default value is false.

When you display a Save Confirmation dialog from a Save button or hyperlink, the Overwrite property should be false.

When you display a Save Confirmation dialog in response to a SaveEvent that a thin presentation bean sends to a ThinViewListener, call this method to set the Overwrite property to true.

Parameters:

overwrite - true to ask whether the user wants to overwrite an existing view, false to ask whether the user wants to save changes to the view.

isOverwrite

public boolean isOverwrite()

Indicates whether this SaveConfirmation will ask if the user wants to overwrite an existing view. The default value is false.

Returns:

true if this SaveConfirmation will ask whether the user wants to overwrite an existing view, false if this SaveConfirmation will ask whether the user wants to save changes to the view.