public class QueryOperationEvent
extends javax.faces.event.FacesEvent
A user can perform various operations on saved searches while interacting with a query component. These actions include creating, overriding, deleting, duplicating, selecting, resetting and updating a saved search.
The above actions result in a QueryDescriptor
object to be created, deleted, updated, overridden, reset or retrieved. With the exception of retrieving a QueryDescriptor or its associated TreeModel (which can happen at any phase), all operations on a QueryDescriptor are typically done through calls to the QueryModel
API, during the Apply Request Values phase of the JSF lifecycle. For more information on each API and when its called, please refer to the JavaDoc for QueryModel
.
In addition to the operations on a QueryDescriptor, this event is queued to be broadcast during the Invoke Application phase of the JSF lifecycle. The payload of the QueryOperationEvent always includes the QueryDescriptor on which the specified operation is being performed in a prior phase.
The list of supported operations for this event are.
CREATE UPDATE DELETE DUPLICATE RESET SELECT MODE_CHANGE CRITERION_UPDATE, OVERRIDE
The scenarios under which this event is queued are listed below.
QueryOperationEvent.Operation | User Action | Comments |
---|---|---|
CREATE | Create a new saved search based on the current saved search | Payload is the newly created QueryDescriptor containing the UIHint selections made by the user. |
DUPLICATE | Duplicate a saved search based on another saved search. | Payload is the newly cloned QueryDescriptor containing the UIHint selections made by the user. |
DELETE | Delete a saved search | Payload is the QueryDescriptor to be deleted. |
MODE_CHANGE | Toggle QueryDescriptor's mode | Payload is the QueryDescriptor whose mode needs to be toggled |
RESET | Reset a saved search to its original state | Payload is the QueryDescriptor that is to be reset. |
SELECT | select a different saved search | Payload is the QueryDescriptor of the selected saved search |
UPDATE | Update a saved search. Users are prevented from updating a saved search that is marked as immutable. | Payload is the updated QueryDescriptor. |
CRITERION_UPDATE | The value of the AttributeCriterion is updated i.e., pushed to model. This event and type is raised only for criterion with dependents. | Payload is the AttributeCriterion instance. |
OVERRIDE | Override an existing saved search with new values and/or criteria | Payload is the QueryDescriptor which is updated and the UIHint selections made by the user. |
Modifier and Type | Class and Description |
---|---|
static class |
QueryOperationEvent.Operation
Types of operation supported by a QueryOperationEvent.
|
source
Constructor and Description |
---|
QueryOperationEvent(javax.faces.component.UIComponent source, QueryOperationEvent.Operation operation, QueryDescriptor descriptor)
Constuctor of QueryOperationEvent.
|
QueryOperationEvent(javax.faces.component.UIComponent source, QueryOperationEvent.Operation operation, QueryDescriptor descriptor, AttributeCriterion criterion)
Constructor of a QueryOperationEvent, queued when the value of a criterion with dependent criterion, changes.
|
QueryOperationEvent(javax.faces.component.UIComponent source, QueryOperationEvent.Operation operation, QueryDescriptor descriptor, Map<String,Object> updatedHints)
Constuctor of QueryOperationEvent, when the UI hints for a descriptor changes.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
AttributeCriterion |
getAttributeCriterion()
Returns the AttributeCriterion instance associated with the event.
|
QueryDescriptor |
getDescriptor()
Returns the QueryDescriptor on which the user performed the operation.
|
QueryOperationEvent.Operation |
getOperation()
Returns the operation associated with the event.
|
Map<String,Object> |
getUpdatedHints()
Returns the updated hints that is to be used on the descriptor that is being updated or the new descriptor that is being created.
|
int |
hashCode() |
boolean |
isAppropriateListener(javax.faces.event.FacesListener listener) |
void |
processListener(javax.faces.event.FacesListener listener) |
String |
toString() |
getComponent, getPhaseId, queue, setPhaseId
getSource
public QueryOperationEvent(javax.faces.component.UIComponent source, QueryOperationEvent.Operation operation, QueryDescriptor descriptor)
source
- UIComponent the component instance for the event.operation
- Operation the operation for the event.descriptor
- QueryDescriptor the descriptor for the event.public QueryOperationEvent(javax.faces.component.UIComponent source, QueryOperationEvent.Operation operation, QueryDescriptor descriptor, Map<String,Object> updatedHints)
source
- UIComponent the component instance for the event.operation
- Operation the operation for the event.descriptor
- QueryDescriptor the descriptor for the event.updatedHints
- the updated UIHints to use for the descriptor that is being updated including the new display name to use for the descriptor.public QueryOperationEvent(javax.faces.component.UIComponent source, QueryOperationEvent.Operation operation, QueryDescriptor descriptor, AttributeCriterion criterion)
source
- UIComponent the component instance for the event.operation
- Operation the operation for the event.descriptor
- QueryDescriptor the descriptor for the event.criterion
- AttributeCriterion the criterion for the eventpublic AttributeCriterion getAttributeCriterion()
public QueryDescriptor getDescriptor()
public QueryOperationEvent.Operation getOperation()
public Map<String,Object> getUpdatedHints()
public void processListener(javax.faces.event.FacesListener listener)
processListener
in class javax.faces.event.FacesEvent
public boolean isAppropriateListener(javax.faces.event.FacesListener listener)
isAppropriateListener
in class javax.faces.event.FacesEvent
public String toString()
toString
in class EventObject