org.kuali.ole.docstore.common.search

Class SearchParams

java.lang.Object

org.kuali.ole.docstore.common.search.SearchParams

Direct Known Subclasses:

BrowseParams

public class SearchParams
extends Object

Java class for searchParams complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="searchParams">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="pageSize" type="{http://www.w3.org/2001/XMLSchema}int"/>
         <element name="searchConditions" type="{}searchCondition" maxOccurs="unbounded" minOccurs="0"/>
         <element name="searchResultFields" type="{}searchResultField" maxOccurs="unbounded" minOccurs="0"/>
         <element name="sortConditions" type="{}sortCondition" maxOccurs="unbounded" minOccurs="0"/>
         <element name="startIndex" type="{http://www.w3.org/2001/XMLSchema}int"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected List<FacetCondition>	facetConditions
protected TreeSet<String>	facetFields
protected int	facetLimit
protected int	facetOffset
protected String	facetPrefix
protected String	facetSort
protected int	pageSize
protected List<SearchCondition>	searchConditions
protected List<SearchResultField>	searchResultFields
protected List<SortCondition>	sortConditions
protected int	startIndex

Constructor Summary

Constructors

Constructor and Description
SearchParams()

Method Summary

Methods

Modifier and Type	Method and Description
SearchCondition	buildSearchCondition(String searchScope, SearchField searchField, String operator)
SearchField	buildSearchField(String docType, String fieldName, String fieldValue)
void	buildSearchParams(SearchParams searchParams, String docType)
SearchResultField	buildSearchResultField(String docType, String fieldName)
SortCondition	buildSortCondition(String sortField, String sortOrder)
Object	deserialize(String content)
List<FacetCondition>	getFacetConditions() Gets the value of the facetCondtions property.
TreeSet<String>	getFacetFields()
int	getFacetLimit()
int	getFacetOffset()
String	getFacetPrefix()
String	getFacetSort()
int	getPageSize() Gets the value of the pageSize property.
List<SearchCondition>	getSearchConditions() Gets the value of the searchConditions property.
List<SearchResultField>	getSearchResultFields() Gets the value of the searchResultFields property.
List<SortCondition>	getSortConditions() Gets the value of the sortConditions property.
int	getStartIndex() Gets the value of the startIndex property.
String	serialize(Object object)
void	setFacetLimit(int facetLimit)
void	setFacetOffset(int facetOffset)
void	setFacetPrefix(String facetPrefix)
void	setFacetSort(String facetSort)
void	setPageSize(int value) Sets the value of the pageSize property.
void	setStartIndex(int value) Sets the value of the startIndex property.

Methods inherited from class java.lang.Object

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

Field Detail

pageSize

protected int pageSize

facetConditions

protected List<FacetCondition> facetConditions

searchConditions

protected List<SearchCondition> searchConditions

searchResultFields

protected List<SearchResultField> searchResultFields

sortConditions

protected List<SortCondition> sortConditions

facetFields

protected TreeSet<String> facetFields

startIndex

protected int startIndex

facetLimit

protected int facetLimit

facetPrefix

protected String facetPrefix

facetSort

protected String facetSort

facetOffset

protected int facetOffset

Constructor Detail

SearchParams

public SearchParams()

Method Detail

getFacetLimit

public int getFacetLimit()

setFacetLimit

public void setFacetLimit(int facetLimit)

getFacetConditions

public List<FacetCondition> getFacetConditions()

Gets the value of the facetCondtions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the facetCondtions property.

For example, to add a new item, do as follows:

    getFacetCondtions().add(newItem);
 

Objects of the following type(s) are allowed in the list FacetCondition

getPageSize

public int getPageSize()

Gets the value of the pageSize property.

setPageSize

public void setPageSize(int value)

Sets the value of the pageSize property.

getSearchConditions

public List<SearchCondition> getSearchConditions()

Gets the value of the searchConditions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the searchConditions property.

For example, to add a new item, do as follows:

    getSearchConditions().add(newItem);
 

Objects of the following type(s) are allowed in the list SearchCondition

getSearchResultFields

public List<SearchResultField> getSearchResultFields()

Gets the value of the searchResultFields property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the searchResultFields property.

For example, to add a new item, do as follows:

    getSearchResultFields().add(newItem);
 

Objects of the following type(s) are allowed in the list SearchResultField

getSortConditions

public List<SortCondition> getSortConditions()

Gets the value of the sortConditions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the sortConditions property.

For example, to add a new item, do as follows:

    getSortConditions().add(newItem);
 

Objects of the following type(s) are allowed in the list SortCondition

getFacetFields

public TreeSet<String> getFacetFields()

getStartIndex

public int getStartIndex()

Gets the value of the startIndex property.

setStartIndex

public void setStartIndex(int value)

Sets the value of the startIndex property.

getFacetPrefix

public String getFacetPrefix()

setFacetPrefix

public void setFacetPrefix(String facetPrefix)

getFacetSort

public String getFacetSort()

setFacetSort

public void setFacetSort(String facetSort)

getFacetOffset

public int getFacetOffset()

setFacetOffset

public void setFacetOffset(int facetOffset)

buildSearchCondition

public SearchCondition buildSearchCondition(String searchScope,
                                   SearchField searchField,
                                   String operator)

buildSearchField

public SearchField buildSearchField(String docType,
                           String fieldName,
                           String fieldValue)

buildSortCondition

public SortCondition buildSortCondition(String sortField,
                               String sortOrder)

buildSearchResultField

public SearchResultField buildSearchResultField(String docType,
                                       String fieldName)

serialize

public String serialize(Object object)

deserialize

public Object deserialize(String content)

buildSearchParams

public void buildSearchParams(SearchParams searchParams,
                     String docType)