oracle.adf.view.rich.component

Class PartialUIXQuery

java.lang.Object

javax.faces.component.UIComponent

org.apache.myfaces.trinidad.component.UIXComponent

org.apache.myfaces.trinidad.component.UIXComponentBase

oracle.adf.view.rich.component.PartialUIXQuery

All Implemented Interfaces:

EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

Direct Known Subclasses:

UIXQuery

public abstract class PartialUIXQuery
extends org.apache.myfaces.trinidad.component.UIXComponentBase

Events:

Type	Phases	Description
oracle.adf.view.rich.event.QueryEvent	Invoke Application Apply Request Values	The Query event is delivered when a query action is triggered.
oracle.adf.view.rich.event.QueryOperationEvent	Invoke Application Apply Request Values	The QueryOperationEvent is generated for all operations performed on saved searches. These include creating, deleting, duplicating, reseting and selecting a saved search.
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	CONJUNCTION_READ_ONLY_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MODEL_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	QUERY_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	QUERY_OPERATION_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	VALUE_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PartialUIXQuery(String rendererType) Construct an instance of the PartialUIXQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	addQueryListener(QueryListener listener) Adds a query listener.
void	addQueryOperationListener(QueryOperationListener listener) Adds a queryOperation listener.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
String	getFamily()
QueryModel	getModel() Gets a QueryModel object that collectively represents the entire model for the query component.
javax.el.MethodExpression	getQueryListener() Gets a method reference to a Querylistener.
QueryListener[]	getQueryListeners() Returns an array of attached query listeners.
javax.el.MethodExpression	getQueryOperationListener() Gets a method reference to a QueryOperationlistener
QueryOperationListener[]	getQueryOperationListeners() Returns an array of attached queryOperation listeners.
QueryDescriptor	getValue() Gets a QueryDescriptor object.
boolean	isConjunctionReadOnly() Gets whether the conjunction is readOnly or not
void	removeQueryListener(QueryListener listener) Removes a query listener.
void	removeQueryOperationListener(QueryOperationListener listener) Removes a queryOperation listener.
void	setConjunctionReadOnly(boolean conjunctionReadOnly) Sets whether the conjunction is readOnly or not
void	setModel(QueryModel model) Sets a QueryModel object that collectively represents the entire model for the query component.
void	setQueryListener(javax.el.MethodExpression queryListener) Sets a method reference to a Querylistener.
void	setQueryOperationListener(javax.el.MethodExpression queryOperationListener) Sets a method reference to a QueryOperationlistener
void	setValue(QueryDescriptor value) Sets a QueryDescriptor object.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setupFlattenedChildrenContext, setupFlattenedContext, setValueBinding, setValueExpression, subscribeToEvent, tearDownFlattenedChildrenContext, tearDownFlattenedContext, toString, unsubscribeFromEvent, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

CONJUNCTION_READ_ONLY_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey CONJUNCTION_READ_ONLY_KEY

VALUE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VALUE_KEY

MODEL_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MODEL_KEY

QUERY_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey QUERY_LISTENER_KEY

QUERY_OPERATION_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey QUERY_OPERATION_LISTENER_KEY

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

PartialUIXQuery

protected PartialUIXQuery(String rendererType)

Construct an instance of the PartialUIXQuery.

Method Detail

isConjunctionReadOnly

public final boolean isConjunctionReadOnly()

Gets whether the conjunction is readOnly or not

Returns:

the new conjunctionReadOnly value

setConjunctionReadOnly

public final void setConjunctionReadOnly(boolean conjunctionReadOnly)

Sets whether the conjunction is readOnly or not

Parameters:

conjunctionReadOnly - the new conjunctionReadOnly value

getValue

public final QueryDescriptor getValue()

Gets a QueryDescriptor object. This provides information about the currently selected saved search. For details about QueryDescriptor, please refer to oracle.adf.view.rich.model.QueryDescriptor

Returns:

the new value value

setValue

public final void setValue(QueryDescriptor value)

Sets a QueryDescriptor object. This provides information about the currently selected saved search. For details about QueryDescriptor, please refer to oracle.adf.view.rich.model.QueryDescriptor

Parameters:

value - the new value value

getModel

public final QueryModel getModel()

Gets a QueryModel object that collectively represents the entire model for the query component. The QueryModel manages QueryDescriptors, iow, supports methods to create, clone (from an existing), delete, reset and update a QueryDescriptor. For details about QueryModel, please refer to the Javadocs for oracle.adf.view.rich.model.QueryModel.

Returns:

the new model value

setModel

public final void setModel(QueryModel model)

Sets a QueryModel object that collectively represents the entire model for the query component. The QueryModel manages QueryDescriptors, iow, supports methods to create, clone (from an existing), delete, reset and update a QueryDescriptor. For details about QueryModel, please refer to the Javadocs for oracle.adf.view.rich.model.QueryModel.

Parameters:

model - the new model value

getQueryListener

public final javax.el.MethodExpression getQueryListener()

Gets a method reference to a Querylistener. The queryListener is called when the user preforms a search.

Returns:

the new queryListener value

setQueryListener

public final void setQueryListener(javax.el.MethodExpression queryListener)

Sets a method reference to a Querylistener. The queryListener is called when the user preforms a search.

Parameters:

queryListener - the new queryListener value

getQueryOperationListener

public final javax.el.MethodExpression getQueryOperationListener()

Gets a method reference to a QueryOperationlistener

Returns:

the new queryOperationListener value

setQueryOperationListener

public final void setQueryOperationListener(javax.el.MethodExpression queryOperationListener)

Sets a method reference to a QueryOperationlistener

Parameters:

queryOperationListener - the new queryOperationListener value

addQueryListener

public final void addQueryListener(QueryListener listener)

Adds a query listener.

Parameters:

listener - the query listener to add

removeQueryListener

public final void removeQueryListener(QueryListener listener)

Removes a query listener.

Parameters:

listener - the query listener to remove

getQueryListeners

public final QueryListener[] getQueryListeners()

Returns an array of attached query listeners.

Returns:

an array of attached query listeners.

addQueryOperationListener

public final void addQueryOperationListener(QueryOperationListener listener)

Adds a queryOperation listener.

Parameters:

listener - the queryOperation listener to add

removeQueryOperationListener

public final void removeQueryOperationListener(QueryOperationListener listener)

Removes a queryOperation listener.

Parameters:

listener - the queryOperation listener to remove

getQueryOperationListeners

public final QueryOperationListener[] getQueryOperationListeners()

Returns an array of attached queryOperation listeners.

Returns:

an array of attached queryOperation listeners.

getFamily

public String getFamily()

Specified by:

getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXComponentBase