DEPRECATED Use `com.bea.p13n.content.expression.Search``` instead.

# com.beasys.commerce.foundation.expression
Search Interface

public interface Search
extends `Cloneable`, `Comparable`, `Serializable`

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.

Related Topics

``SearchHome``
``SearchImpl``
``ExpressionHelper``

All Known Implementing Classes
  `com.beasys.commerce.foundation.expression.SearchImpl`

All Superinterfaces
  `Cloneable`, `Comparable`, `Serializable`

## Method Summary

`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`` | `interfaceName`() Get the interface name.
`public void` | `setByValue`(`Object` val) Set this object.
`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 `Object`` | `value`() Get a value object initialized from this.

Methods from interface `java.lang.`Comparable``
`compareTo`

## Method Detail

### 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.

### interfaceName() Method

    public String interfaceName()

Get the interface name.

### setByValue(Object) Method

    public void setByValue(Object val)

Set this object.

### 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.

### value() Method

    public Object value()

Get a value object initialized from this.