org.eaglei.model.webapp.client.searchbar
Class TermSearchRequest

java.lang.Object
  org.eaglei.model.webapp.client.searchbar.TermSearchRequest

All Implemented Interfaces:

java.io.Serializable

public class TermSearchRequest
extends java.lang.Object
implements java.io.Serializable

Represents a search request.

See Also:

Serialized Form

Nested Class Summary

static class	TermSearchRequest.Term
static class	TermSearchRequest.TypeBinding Set of resource type-specific bindings for a search.

Field Summary

static int	DEFAULT_PAGE_SIZE
static long	serialVersionUID

Constructor Summary

TermSearchRequest()

TermSearchRequest(org.eaglei.model.EIURI uri)

TermSearchRequest(java.lang.String query)

TermSearchRequest(TermSearchRequest.Term term)

Method Summary

boolean	equals(java.lang.Object obj)
TermSearchRequest.TypeBinding	getBinding() Gets the search resource type binding, may be null.
org.eaglei.model.EIURI	getInstitution() Get the URI for the eagle-i institution instance used to constrain the search term
int	getMaxResults() Gets the max number of results.
int	getStartIndex() Gets the request start index.
TermSearchRequest.Term	getTerm() Gets the search term, may be null.
int	hashCode()
static TermSearchRequest	parse(java.lang.String strParams) Parses a param list into a search request.
void	setBinding(TermSearchRequest.TypeBinding binding) Sets the search resource type binding.
void	setInstitution(org.eaglei.model.EIURI institution) Sets the URI for the eagle-i institution instance used to constrain the search term.
void	setMaxResults(int maxResults) Sets the maximum results to return.
void	setStartIndex(int startIndex) Sets the search request start index.
void	setTerm(TermSearchRequest.Term term) Sets the search term.
java.lang.String	toString()
java.lang.String	toURLParams() Returns a string representation of this request suitable for use as the param list in a catalyst search URL.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

Constructor Detail

TermSearchRequest

public TermSearchRequest()

TermSearchRequest

public TermSearchRequest(java.lang.String query)

TermSearchRequest

public TermSearchRequest(org.eaglei.model.EIURI uri)

TermSearchRequest

public TermSearchRequest(TermSearchRequest.Term term)

Method Detail

parse

public static TermSearchRequest parse(java.lang.String strParams)

Parses a param list into a search request. Invalid params will be ignored.

Parameters:

strParams -

Returns:

SearchRequest

getInstitution

public org.eaglei.model.EIURI getInstitution()

Get the URI for the eagle-i institution instance used to constrain the search term

Returns:

Institution URI. May be null.

setInstitution

public void setInstitution(org.eaglei.model.EIURI institution)

Sets the URI for the eagle-i institution instance used to constrain the search term.

Parameters:

institution - Institution URI.

getTerm

public TermSearchRequest.Term getTerm()

Gets the search term, may be null.

setTerm

public void setTerm(TermSearchRequest.Term term)

Sets the search term.

Parameters:

term - The search term

getBinding

public TermSearchRequest.TypeBinding getBinding()

Gets the search resource type binding, may be null.

setBinding

public void setBinding(TermSearchRequest.TypeBinding binding)

Sets the search resource type binding.

Parameters:

binding - The search result resource type binding.

getStartIndex

public int getStartIndex()

Gets the request start index.

Returns:

The request start index.

setStartIndex

public void setStartIndex(int startIndex)

Sets the search request start index.

Parameters:

startIndex - The start index.

getMaxResults

public int getMaxResults()

Gets the max number of results.

Returns:

Maximum results to return.

setMaxResults

public void setMaxResults(int maxResults)

Sets the maximum results to return.

Parameters:

maxResults - Maximum number of results to return.

toURLParams

public java.lang.String toURLParams()

Returns a string representation of this request suitable for use as the param list in a catalyst search URL.

Returns:

param String

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object