oracle.dss.thin.beans.dataView
Class SaveAs

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

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI

Direct Known Subclasses:

SaveConfirmation

public class SaveAs

extends ThinBeanDialog

The ThinBeanUI for the Save As dialog. The Save As dialog presents options for saving a thin presentation bean to the BI Beans Catalog. Use the SaveAs thin bean in conjunction with the oracle.dss.beans.persistence.ExplorerDetail.

The SaveAs generates a BIConstants.SAVE_EVENT, which the thin presentation bean handles. The thin presentation bean actually performs the save operation.

The SaveAs 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 SaveAs. 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 SaveAs. Set an EventTarget to direct this event to the application page to navigate to when users choose Cancel.

The SaveAs handles the following events:

• BIConstants.INIT_EVENT -- This dialog handles this 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.
• BIConstants.SUBMIT_FOLDER_EVENT -- This dialog handles this event by setting its properties from the SUBMIT_FOLDER_EVENT parameters. This event is generated when a user clicks the Apply button in the ExplorerDetail.

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

See Also:

InitEventDataObject, ExplorerDetail, ThinDataviewCommon, PersistableAttributes

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

SaveAs()
Constructor.

Method Summary

java.lang.String	getDescription() Retrieves the description for the object that is being saved.
java.lang.String	getFormName() Retrieves the name of the form in which to render this SaveAs.
java.lang.String	getFrameName() Retrieves the name of the frame in which to display this SaveAs.
java.lang.String	getKeywords() Retrieves the keywords for the object that is being saved.
java.lang.String	getLocation() Retrieves the location in which the object will be saved.
java.lang.String	getName() Retrieves the name under which to save the object.
java.lang.String	getRootName() Retrieves the display name for the root folder.
int	handleEvent(QueryParameterProvider provider) Handles a thin-bean event.
void	setDescription(java.lang.String description) Specifies the description for the object that is being saved.
void	setFormName(java.lang.String formName) Specifies the name of the form in which to render this SaveAs.
void	setFrameName(java.lang.String frameName) Specifies the name of the frame in which to display this SaveAs.
void	setKeywords(java.lang.String keywords) Specifies search keywords for the object that is being saved.
void	setLocation(java.lang.String location) Specifies the location in which to save the object.
void	setName(java.lang.String name) Specifies the name under which to save the object.
void	setRootName(java.lang.String rootName) Specifies the root folder name.

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

SaveAs

public SaveAs()

Constructor.

Method Detail

handleEvent

public int handleEvent(QueryParameterProvider provider)
                throws ThinException

Description copied from interface: ThinBeanUI

Handles a thin-bean event. This ThinBeanUI handles events where the value of the source query parameter is the ThinBeanName for this thin bean.

You can examine the source query parameter to determine the thin bean whose handleEvent to call. Or you can call the handleEvent for each thin bean, checking the return from this method to discover which thin bean handled the event. Alternately, you can register thin beans with the ServletRequestHandler and call the handleEvent method of the ServletRequestHandler. The ServletRequestHandler will then route the event to the proper thin bean.

For more information about thin-bean events, see the BI Beans Help system.

Overrides:

handleEvent in class ThinBeanDialog

Following copied from interface: oracle.dss.thin.beans.ThinBeanUI

Parameters:

provider - The QueryParameterProvider for the HTTPServletRequest that is being handled.

Returns:

A constant that indicates whether this ThinBeanUI handled any events. Constants are listed in the See Also section.

Throws:

ThinException - If an error occurs that interrupts event handling.

See Also:

ThinBeanUI.EVENT_NOT_HANDLED, ThinBeanUI.EVENT_HANDLED, ThinBeanUI.EVENT_RESPONSE_DONE, ServletRequestHandler

setName

public void setName(java.lang.String name)

Specifies the name under which to save the object. To provide a default value for the Name field, in your initialization code, set the Name to the ObjectName attribute from the PersistableAttributes of the view that is being saved.

Parameters:

name - The name to give the object.

getName

public java.lang.String getName()

Retrieves the name under which to save the object.

Returns:

The name for the object.

setDescription

public void setDescription(java.lang.String description)

Specifies the description for the object that is being saved. To provide a default value for the Description field, in your initialization code, set the Description to the Description attribute from the PersistableAttributes of the view that is being saved.

Parameters:

description - The description for the object.

getDescription

public java.lang.String getDescription()

Retrieves the description for the object that is being saved.

Returns:

The description for the object.

setKeywords

public void setKeywords(java.lang.String keywords)

Specifies search keywords for the object that is being saved. To provide a default value for the Keywords field, in your initialization code, set the Keywords to the Keywords attribute from the PersistableAttributes of the view that is being saved.

Parameters:

keywords - Search keywords for the object.

getKeywords

public java.lang.String getKeywords()

Retrieves the keywords for the object that is being saved.

Returns:

The search keywords for the object.

setLocation

public void setLocation(java.lang.String location)

Specifies the location in which to save the object.

Parameters:

location - The path that specifies the folder in which to save the object.

getLocation

public java.lang.String getLocation()

Retrieves the location in which the object will be saved.

Returns:

The path that specifies the folder in which to save the object.

getRootName

public java.lang.String getRootName()

Retrieves the display name for the root folder.

Returns:

The name of the root folder.

setRootName

public void setRootName(java.lang.String rootName)

Specifies the root folder name.

Parameters:

rootName - The name of the root folder.

setFrameName

public void setFrameName(java.lang.String frameName)

Specifies the name of the frame in which to display this SaveAs. This property is used to improve synchronization with the ExplorerTree, when the ExplorerTree and the SaveAs are displayed in different frames in a browser page.

Parameters:

frameName - The name of the frame in which to display this SaveAs.

getFrameName

public java.lang.String getFrameName()

Retrieves the name of the frame in which to display this SaveAs. This property is used to improve synchronization with the ExplorerTree, when the ExplorerTree and the SaveAs are displayed in different frames in a browser page.

Returns:

The name of the frame for this SaveAs.

setFormName

public void setFormName(java.lang.String formName)

Specifies the name of the form in which to render this SaveAs. This property is used to improve synchronization with the ExplorerTree, when the ExplorerTree and the SaveAs are displayed in different forms in a browser page.

Parameters:

formName - The name of the form for this SaveAs.

getFormName

public java.lang.String getFormName()

Retrieves the name of the form in which to render this SaveAs. This property is used to improve synchronization with the ExplorerTree, when the ExplorerTree and the SaveAs are displayed in different forms in a browser page.

Returns:

The name of the form for this SaveAs.