Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.3.0)
E17488-04


oracle.adf.view.rich.event
Class QueryEvent

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

All Implemented Interfaces:
java.io.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(java.lang.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.
 java.lang.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 java.lang.Object

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.util.EventObject

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 2 (11.1.2.3.0)
E17488-04


Copyright (c) 1998, 2012, Oracle and/or its affiliates. All rights reserved.