oracle.dss.thin.beans.dataView
Class SaveEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--oracle.dss.thin.beans.dataView.SaveEvent

All Implemented Interfaces:

java.io.Serializable

public class SaveEvent

extends java.util.EventObject

Describes a Save operation. A thin presentation bean sends a SaveEvent to ThinViewListener implementation that have been registered with the presentation.

See Also:

ThinViewListener, Serialized Form

Constructor Summary

SaveEvent(java.lang.Object source, java.lang.String name, java.lang.String description, java.lang.String keywords, java.lang.String location, java.lang.String overwrite, QueryParameterProvider provider)
Constructor.

Method Summary

void	confirmationRequested() Requests a save confirmation event.
void	consume() Consumes this event.
java.lang.String	getDescription() Retrieves the description for the view.
java.lang.String	getKeywords() Retrieves the keywords for the view.
java.lang.String	getLocation() Retrieves the folder in which to save the view.
java.lang.String	getName() Retrieves the name under which to save the view.
java.lang.String	getOverwrite() Retrieves an indication of the use of the SAVE_EVENT.
QueryParameterProvider	getQueryParameterProvider() Retrieves the QueryParameterProvider for this event.
boolean	isConfirmationRequested() Indicates whether the ThinViewListener requested a save confirmation event.
boolean	isConsumed() Indicates whether this event has been consumed.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SaveEvent

public SaveEvent(java.lang.Object source,
                 java.lang.String name,
                 java.lang.String description,
                 java.lang.String keywords,
                 java.lang.String location,
                 java.lang.String overwrite,
QueryParameterProvider provider)

Constructor.

Parameters:

source - The view that generates this SaveEvent.

name - The name for the saved view.

description - The description for the saved view.

keywords - The keywords for the saved view.

location - The folder in which to save the view.

overwrite - The value of the Overwrite property.

provider - The QueryParameterProvider for the current request

Method Detail

getName

public java.lang.String getName()

Retrieves the name under which to save the view. This value comes from the SAVE_NAME+ORIGIN parameter of the SAVE_EVENT.

Returns:

The name for the saved view.

See Also:

BIConstants.SAVE_EVENT

getDescription

public java.lang.String getDescription()

Retrieves the description for the view. This value comes from the DESCRIPTION+ORIGIN parameter of the SAVE_EVENT.

Returns:

The description for the view that is being saved.

See Also:

BIConstants.SAVE_EVENT

getKeywords

public java.lang.String getKeywords()

Retrieves the keywords for the view. This value comes from the KEYWORDS+ORIGIN parameter of the SAVE_EVENT.

Returns:

The keywords for the view that is being saved.

See Also:

BIConstants.SAVE_EVENT

getLocation

public java.lang.String getLocation()

Retrieves the folder in which to save the view. This value comes from the LOCATION+ORIGIN parameter of the SAVE_EVENT.

Returns:

The folder in which the view should be saved.

See Also:

BIConstants.SAVE_EVENT

getOverwrite

public java.lang.String getOverwrite()

Retrieves an indication of the use of the SAVE_EVENT. This value comes from the SAVE_OVERWRITE+ORIGIN parameter of the SAVE_EVENT.

Returns:

A constant that indicates whether the Save Confirmation should prompt for whether users want to overwrite an existing view.

See Also:

BIConstants.SAVE_EVENT, BIConstants.SAVE_OVERWRITE_YES, BIConstants.SAVE_OVERWRITE_NO

getQueryParameterProvider

public QueryParameterProvider getQueryParameterProvider()

Retrieves the QueryParameterProvider for this event.

Returns:

The QueryParameterProvider of the current request.

See Also:

BIConstants.SAVE_EVENT

consume

public void consume()

Consumes this event. After you call this method, no further action is taken by the event source.

isConsumed

public boolean isConsumed()

Indicates whether this event has been consumed. After an event is consumed, no further action should be taken by the event source.

Returns:

boolean true if this event has been consumed, false if it has not.

confirmationRequested

public void confirmationRequested()

Requests a save confirmation event. Call this method in your ThinViewListener to have the view call the saveConfirmationRequested method of registered listeners.

See Also:

ThinViewListener.saveConfirmationRequested(oracle.dss.thin.beans.dataView.SaveEvent)

isConfirmationRequested

public boolean isConfirmationRequested()

Indicates whether the ThinViewListener requested a save confirmation event. This method returns true after a call to confirmationRequested. If this method returns true, then the view calls the saveConfirmationRequested method of any registered listeners.

Returns:

boolean true if a save confirmation has been requested, false if it has not.

See Also:

ThinViewListener.saveConfirmationRequested(oracle.dss.thin.beans.dataView.SaveEvent)