Search Class

DEPRECATED

com.bea.p13n.content.expression
Search Class

public class Search

    extends Object
    implements Cloneable, Serializable

This represents parameters for searching for objects, specifically Content objects.

Attribute: maxReturn Attribute: sort Attribute: expression Attribute: userId Attribute: contextParams


Hierarchy
Object
  Search
All Implemented Interfaces

Cloneable, Serializable

Field Summary

protected Map
contextParams
The context params.
protected com.bea.p13n.expression.Expression
expression
The search expression.
protected long
maxReturn
The maximum number of objects to return.
protected String
sort
The sorting criteria
protected String
userId
The user id.
 

Constructor Summary

Search()

Empty constructor.
Search(String userId, long maxReturn, String sort, Expression expr)

Constructor.
Search(long maxReturn, String sort, Expression expression)

Constructor.
 

Method Summary

public Object
clone()
Make a shallow copy of this object.
public boolean
equals(Object o)
Determine if another object is equals to this.
public Object
getContextParam(Object key)
Get the value of a context param.
public Map
getContextParams()
Get an unmodifiable copy of the context params.
public Expression
getExpression()
Get the search expression.
public long
getMaxReturn()
Get the maximum number of objects to return.
public String
getSort()
Get the sort criteria.
public String
getUserId()
Get the user id.
public int
hashCode()
Override hashcode to use our parts.
public Object
setContextParam(Object key, Object value)
Set the value of a context param.
public void
setContextParams(Map input)
Set the context params based upon the objects in the input map.
public void
setExpression(Expression expression)
Set the search expression.
public void
setMaxReturn(long maxReturn)
Set the maximum number of objects to return.
public void
setSort(String sort)
Set the sort criteria.
public void
setUserId(String userId)
Set the user id.
public String
toString()
Get a String representation of this.
 
Methods from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
   

Field Detail

contextParams

protected Map contextParams
The context params.


expression

protected com.bea.p13n.expression.Expression expression
The search expression.


maxReturn

protected long maxReturn
The maximum number of objects to return.


sort

protected String sort
The sorting criteria


userId

protected String userId
The user id.

 

Constructor Detail

Search

public Search()
Empty constructor.

Search

public Search(String userId, 
              long maxReturn, 
              String sort, 
              Expression expr)
Constructor.

Search

public Search(long maxReturn, 
              String sort, 
              Expression expression)
Constructor.
 

Method Detail

clone() Method

public Object clone()
Make a shallow copy of this object.

Overrides
Object.clone()

equals(Object) Method

public boolean equals(Object o)
Determine if another object is equals to this.

Overrides
Object.equals(Object)

getContextParam(Object) Method

public Object getContextParam(Object key)
Get the value of a context param.


getContextParams() Method

public Map getContextParams()
Get an unmodifiable copy of the context params.


getExpression() Method

public Expression getExpression()
Get the search expression.


getMaxReturn() Method

public long getMaxReturn()
Get the maximum number of objects to return.


getSort() Method

public String getSort()
Get the sort criteria.


getUserId() Method

public String getUserId()
Get the user id.


hashCode() Method

public int hashCode()
Override hashcode to use our parts.

Overrides
Object.hashCode()

setContextParam(Object, Object) Method

public Object setContextParam(Object key, 
                              Object value)
Set the value of a context param.

The key and value must be Serializable.

Parameters

key
the context param key.
value
the context param value.

Returns

the old context param value or null if none.

setContextParams(Map) Method

public void setContextParams(Map input)
Set the context params based upon the objects in the input map.


setExpression(Expression) Method

public void setExpression(Expression expression)
Set the search expression.


setMaxReturn(long) Method

public void setMaxReturn(long maxReturn)
Set the maximum number of objects to return.


setSort(String) Method

public void setSort(String sort)
Set the sort criteria.


setUserId(String) Method

public void setUserId(String userId)
Set the user id.


toString() Method

public String toString()
Get a String representation of this.

Overrides
Object.toString()