com.beasys.commerce.foundation.expression
Interface Search

All Superinterfaces:

Belonging, BusinessSmartComponent, java.lang.Cloneable, java.lang.Comparable, java.io.Serializable

All Known Implementing Classes:

SearchImpl

public interface Search

extends Belonging

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

Attribute: maxReturn

• Containment: By Value
• Multiplicity: 1:1
• This specifies the maximum number of objects to return. It should 0 or less to specifying returning all objects that match, no matter how large.

Attribute: sort

• Containment: By Value
• Multiplicity: 1:1
• This specifies the SQL ORDER BY-style clause the controlling the sorting on the return list. It is a comma-separated list of property names, each optionally appended with either "ASC" (ascending sort) or "DESC" (descending sort). For example, "creationDate ASC, mimeType DESC, identifier" would specify to sort ascending on on creationDate, to next sort descending on mimeType, and to finally sort ascending on identifier.

Attribute: expression

• Containment: By Value
• Multiplicity: 1:1
• This specifies the Expression the objects must match against.

See Also:

SearchHome, SearchImpl, ExpressionHelper

Method Summary

Expression	getExpression() Get the search expression.
long	getMaxReturn() Get the maximum number of objects to return.
java.lang.String	getSort() Get the sort criteria.
void	setExpression(Expression expression) Set the search expression.
void	setMaxReturn(long maxReturn) Set the maximum number of objects to return.
void	setSort(java.lang.String sort) Set the sort criteria.

Methods inherited from interface com.beasys.commerce.foundation.Belonging

clone, equals, interfaceName, setByValue, value

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getMaxReturn

public long getMaxReturn()

Get the maximum number of objects to return.

setMaxReturn

public void setMaxReturn(long maxReturn)

Set the maximum number of objects to return.

getSort

public java.lang.String getSort()

Get the sort criteria.

setSort

public void setSort(java.lang.String sort)

Set the sort criteria.

getExpression

public Expression getExpression()

Get the search expression.

setExpression

public void setExpression(Expression expression)

Set the search expression.