ome.parameters

Class Filter

java.lang.Object

ome.parameters.Filter

All Implemented Interfaces:

java.io.Serializable

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

parameter to generally reduce the size of a query result set.

Since:

3.0-M2

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.sql.Timestamp	endTime
java.lang.Integer	limit
java.lang.Integer	offset
java.sql.Timestamp	startTime

Constructor Summary

Constructors

Constructor and Description
Filter()

Method Summary

Modifier and Type	Method and Description
long	group()
Filter	group(long groupId)
boolean	isUnique() check uniqueness for this query.
long	owner()
Filter	owner(long ownerId)
Filter	page(java.lang.Integer offset, java.lang.Integer limit)
java.lang.String	toString()
Filter	unique() state that this Filter should only return a single value if possible.

Methods inherited from class java.lang.Object

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

Field Detail

limit

public java.lang.Integer limit

offset

public java.lang.Integer offset

startTime

public java.sql.Timestamp startTime

endTime

public java.sql.Timestamp endTime

Constructor Detail

Filter

public Filter()

Method Detail

page

public Filter page(java.lang.Integer offset,
                   java.lang.Integer limit)

unique

public Filter unique()

state that this Filter should only return a single value if possible. By default, a Filter will make no assumptions regarding the uniquesness of a query.

isUnique

public boolean isUnique()

check uniqueness for this query. Participating queries will attempt to call uniqueResult rather than list. This may throw a ValidationException on execution.

owner

public Filter owner(long ownerId)

owner

public long owner()

group

public Filter group(long groupId)

group

public long group()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object