Skip navigation links

oracle.adf.view.rich.event
Class QueryEvent

java.lang.Object
java.util.EventObject
javax.faces.event.FacesEvent
oracle.adf.view.rich.event.QueryEvent

All Implemented Interfaces:

Serializable

public class QueryEvent

extends javax.faces.event.FacesEvent

QueryEvent class. QueryEvent is delivered in response to user's action to perform a query. For example, clicking the "go" icon of the quickQuery component or the "Search" button of the query component will queue the QueryEvent to be broadcast at the Invoke Application phase.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

QueryEvent(javax.faces.component.UIComponent source, QueryDescriptor descriptor)
Constructor for QueryEvent.

Method Summary

boolean	equals(Object o)
QueryDescriptor	getDescriptor() Gets the payload of the event.
int	hashCode()
boolean	isAppropriateListener(javax.faces.event.FacesListener listener)
boolean	isClearAll()
void	processListener(javax.faces.event.FacesListener listener)
void	setClearAll(boolean clearAll) Set an attribute on the event indicating that we are going to clear all query/filter fields as part of the query operation.
String	toString()

Methods inherited from class javax.faces.event.FacesEvent

getComponent, getPhaseId, queue, setPhaseId

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryEvent

public QueryEvent(javax.faces.component.UIComponent source,
                  QueryDescriptor descriptor)

Constructor for QueryEvent.

Parameters:

source - the component instance

descriptor - QueryDescriptor the QueryDescriptor for the component

Method Detail

getDescriptor

public QueryDescriptor getDescriptor()

Gets the payload of the event. QueryDescriptor identifies the query that needs to be executed in response to the event.

Returns:

the QueryDescriptor or the payload of the event

setClearAll

public void setClearAll(boolean clearAll)

Set an attribute on the event indicating that we are going to clear all query/filter fields as part of the query operation.

Parameters:

clearAll - flag for clear all

isClearAll

public boolean isClearAll()

Returns:

indicates if all fields should be cleared

processListener

public void processListener(javax.faces.event.FacesListener listener)

Specified by:

processListener in class javax.faces.event.FacesEvent

isAppropriateListener

public boolean isAppropriateListener(javax.faces.event.FacesListener listener)

Specified by:

isAppropriateListener in class javax.faces.event.FacesEvent

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class EventObject

Skip navigation links