omero.sys

Class Filter

java.lang.Object

Ice.ObjectImpl

omero.sys.Filter

All Implemented Interfaces:

Ice.Object, java.io.Serializable, java.lang.Cloneable

public class Filter
extends Ice.ObjectImpl

Provides common filters which MAY be applied to a query. Check the documentation for the particular method for more information on how these values will be interpreted as well as default values if they are missing. In general they are intended to mean: unique := similar to SQL's ""DISTINCT"" keyword ownerId := (some) objects queried should belong to this user groupId := (some) objects queried should belong to this group preferOwner := true implies if if ownerId and groupId are both defined, use only ownerId offset/limit := represent a page which should be loaded Note: servers may choose to impose a maximum limit. start/endTime := (some) objects queried should have been created and/or modified within time span.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	__ids
RTime	endTime
RLong	groupId
RInt	limit
RInt	offset
RLong	ownerId
static long	serialVersionUID
RTime	startTime
RBool	unique

Fields inherited from interface Ice.Object

ice_staticId

Constructor Summary

Constructors

Constructor and Description
Filter()
Filter(RBool unique, RLong ownerId, RLong groupId, RInt offset, RInt limit, RTime startTime, RTime endTime)

Method Summary

Modifier and Type	Method and Description
protected void	__readImpl(IceInternal.BasicStream __is)
protected void	__writeImpl(IceInternal.BasicStream __os)
Filter	clone()
static Ice.ObjectFactory	ice_factory()
java.lang.String	ice_id()
java.lang.String	ice_id(Ice.Current __current)
java.lang.String[]	ice_ids()
java.lang.String[]	ice_ids(Ice.Current __current)
boolean	ice_isA(java.lang.String s)
boolean	ice_isA(java.lang.String s, Ice.Current __current)
static java.lang.String	ice_staticId()

Methods inherited from class Ice.ObjectImpl

___ice_id, ___ice_ids, ___ice_isA, ___ice_ping, __checkMode, __dispatch, __read, __read, __readImpl, __write, __write, __writeImpl, ice_dispatch, ice_dispatch, ice_operationAttributes, ice_ping, ice_ping, ice_postUnmarshal, ice_preMarshal

Methods inherited from class java.lang.Object

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

Field Detail

__ids

public static final java.lang.String[] __ids

unique

public RBool unique

ownerId

public RLong ownerId

groupId

public RLong groupId

offset

public RInt offset

limit

public RInt limit

startTime

public RTime startTime

endTime

public RTime endTime

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

Filter

public Filter()

Filter

public Filter(RBool unique,
              RLong ownerId,
              RLong groupId,
              RInt offset,
              RInt limit,
              RTime startTime,
              RTime endTime)

Method Detail

ice_factory

public static Ice.ObjectFactory ice_factory()

ice_isA

public boolean ice_isA(java.lang.String s)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_isA

public boolean ice_isA(java.lang.String s,
                       Ice.Current __current)

Specified by:

ice_isA in interface Ice.Object

Overrides:

ice_isA in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids()

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_ids

public java.lang.String[] ice_ids(Ice.Current __current)

Specified by:

ice_ids in interface Ice.Object

Overrides:

ice_ids in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id()

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_id

public java.lang.String ice_id(Ice.Current __current)

Specified by:

ice_id in interface Ice.Object

Overrides:

ice_id in class Ice.ObjectImpl

ice_staticId

public static java.lang.String ice_staticId()

__writeImpl

protected void __writeImpl(IceInternal.BasicStream __os)

Overrides:

__writeImpl in class Ice.ObjectImpl

__readImpl

protected void __readImpl(IceInternal.BasicStream __is)

Overrides:

__readImpl in class Ice.ObjectImpl

clone

public Filter clone()

Specified by:

clone in interface Ice.Object

Overrides:

clone in class Ice.ObjectImpl