oracle.alm.view.model
Class AlmSimpleQueryModel

java.lang.Object
  oracle.alm.view.model.AlmSimpleQueryModel

Direct Known Subclasses:

AlmFilterQueryModel

public abstract class AlmSimpleQueryModel
extends java.lang.Object

The AlmSimpleQueryModel class is the common model definitions for both a quick search UI component and an advanced search UI,

Constructor Summary

AlmSimpleQueryModel()

Method Summary

java.lang.String	getDescription(RenderingContext rContext, AlmComponent component)
abstract java.lang.Object	getQueryResources(RenderingContext rContext, AlmComponent component)
java.lang.String	getQueryType() The seach type of the current search.
abstract void	search(RenderingContext rContext, AlmComponent component, java.lang.Object value)

Methods inherited from class java.lang.Object

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

Constructor Detail

AlmSimpleQueryModel

public AlmSimpleQueryModel()

Method Detail

getDescription

public java.lang.String getDescription(RenderingContext rContext,
                                       AlmComponent component)

Parameters:

rContext - The current RenderingContext object

component - The current component with the search functionality, such as a AlmSerchComponent or an AlmQuickSearchComponent object

Returns:

the label to describe the current query.

getQueryResources

public abstract java.lang.Object getQueryResources(RenderingContext rContext,
                                                   AlmComponent component)

Parameters:

rContext - The current RenderingContext object

component - The current component with the search functionality, such as a AlmSerchComponent or an AlmQuickSearchComponent object

Returns:

the resources (category) from which the search will perform. resources is used for the search by type part in the search control

getQueryType

public java.lang.String getQueryType()

The seach type of the current search. Valid values are "SEARCH"and "FILTER", if it is "SEARCH", that means user needs to explicitly click the search button icon to execute the search functionality, if it is "FILTER", then the search is of "type to search" style. By default the advanced search is using "SEARCH" query type, a quick search can support both "SEARCH" and "FILTER".

Returns:

"SEARCH" or "FILTER",

search

public abstract void search(RenderingContext rContext,
                            AlmComponent component,
                            java.lang.Object value)

Parameters:

rContext - The current RenderingContext object

component - The current component with the search functionality, such as a AlmSerchComponent or an AlmQuickSearchComponent object

value - the value object provided to form the query object.