omero.gateway.facility

Class SearchFacility

java.lang.Object

omero.gateway.facility.Facility

omero.gateway.facility.SearchFacility

public class SearchFacility
extends Facility

A Facility for performing searches

Since:

5.1

Author:

Dominik Lindner d.lindner@dundee.ac.uk

Method Summary

Modifier and Type	Method and Description
SearchResultCollection	search(SecurityContext ctx, SearchParameters context) Searches for data.

Methods inherited from class omero.gateway.facility.Facility

addPropertyChangeListener, clear, firePropertyChanged, firePropertyChanged, getFacility, logDebug, logError, logInfo, logWarn, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Method Detail

search

public SearchResultCollection search(SecurityContext ctx,
                                     SearchParameters context)
                              throws DSOutOfServiceException,
                                     DSAccessException

Searches for data.

Parameters:

ctx - The security context.

context - The context of search (if context.groupId == -1 the scope of the search will be all groups, otherwise the scope of the search will be the group set in the security context)

Returns:

The found objects.

Throws:

DSOutOfServiceException - If the connection is broken, or not logged in

DSAccessException - If an error occurred while trying to retrieve data from OMERO service.