oracle.dss.thin.beans
Interface ThinBeanUI

All Superinterfaces:

ThinBean

All Known Subinterfaces:

ThinDataviewCommon, ViewTool

All Known Implementing Classes:

BaseThinBeanUI

public interface ThinBeanUI

extends ThinBean

Methods and constants for BI Beans thin beans that have user-interface components. Each ThinBeanUI implementation has an associated UIX Component that renders HTML for the thin bean.

You can use data binding to use one UIX Component to render HTML for more than one associated ThinBeanUI. For more information about data binding, see the documentation for Oracle UIX Components.

Field Summary

static int	EVENT_HANDLED handleEvent return value: This thin bean handled the event.
static int	EVENT_NOT_HANDLED handleEvent return value: This thin bean did not handle the event.
static int	EVENT_RESPONSE_DONE handleEvent return value: This thin bean handled the event and wrote the HTTP response.

Method Summary

EventTarget	getEventTarget(java.lang.String event) Retrieves the event target for the specified event.
java.util.Locale	getLocale() Retrieves the Locale that this ThinBeanUI uses.
int	handleEvent(QueryParameterProvider provider) Handles a thin-bean event.
void	setEventTarget(java.lang.String event, EventTarget target) Specifies an event target for an event that this ThinBeanUI generates.
void	setLocale(java.util.Locale locale) Specifies the Locale for this ThinBeanUI.

Methods inherited from interface oracle.dss.thin.beans.ThinBean

getState, getThinBeanName, setBaseState, setState, setThinBeanName

Field Detail

EVENT_HANDLED

public static final int EVENT_HANDLED

handleEvent return value: This thin bean handled the event.

EVENT_NOT_HANDLED

public static final int EVENT_NOT_HANDLED

handleEvent return value: This thin bean did not handle the event.

EVENT_RESPONSE_DONE

public static final int EVENT_RESPONSE_DONE

handleEvent return value: This thin bean handled the event and wrote the HTTP response. When handleEvent returns this value, your application should return from the current request without rendering anything else to the response stream.

The ThinDataview returns this value when it handles the export event.

See Also:

BIConstants.EXPORT_EVENT, ThinDataview

Method Detail

handleEvent

public int handleEvent(QueryParameterProvider provider)
                throws ThinException

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.

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:

EVENT_NOT_HANDLED, EVENT_HANDLED, EVENT_RESPONSE_DONE, ServletRequestHandler

setLocale

public void setLocale(java.util.Locale locale)

Specifies the Locale for this ThinBeanUI.

Parameters:

locale - The Locale for this ThinBeanUI.

getLocale

public java.util.Locale getLocale()

Retrieves the Locale that this ThinBeanUI uses.

Returns:

The Locale for this ThinBeanUI.

setEventTarget

public void setEventTarget(java.lang.String event,
EventTarget target)

Specifies an event target for an event that this ThinBeanUI generates. Call this method to specify the ThinBeanUI that should handle the event. You can also use event targets to direct an event to another part of your application, to change the target frame for an event, and to add application parameters to an event.

Parameters:

event - A constant that identifies the event to target. Valid constants are defined in the BIConstants interface and end with "_EVENT".

target - The event target that specifies the thin bean that should handle the event.

See Also:

BIConstants

getEventTarget

public EventTarget getEventTarget(java.lang.String event)

Retrieves the event target for the specified event.

Parameters:

event - A constant that identifies the event whose target you want. Valid constants are defined in the BIConstants interface and end with "_EVENT".

Returns:

The event target that has been set for event.

See Also:

BIConstants