Version: 5.2.4-ice35-b23

OmeroBlitz API
Home Previous Up Next Index

omero::sys::Filter

Overview

class Filter

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 shoud have been created and/or modified within time span.

Used By

api::IQuery::findAll
api::IQuery::findAllByExample
api::IQuery::findAllByString
Parameters::theFilter

Data Member Index

unique
ownerId
groupId
offset
limit
startTime
endTime

Data Members

RBool unique;

RLong ownerId;

RLong groupId;

RInt offset;

RInt limit;

RTime startTime;

RTime endTime;


Home Previous Up Next Index