_SearchOperationsNC (omero-blitz 5.5.12 API)

All Superinterfaces:

_ServiceInterfaceOperationsNC, _StatefulServiceInterfaceOperationsNC

All Known Subinterfaces:

Search

All Known Implementing Classes:

_SearchDisp, _SearchTie
```
public interface _SearchOperationsNC
extends _StatefulServiceInterfaceOperationsNC
```
Central search interface, allowing Web2.0 style queries. Each Search instance keeps up with several queries and lazily-loads the results as hasNext, next and results are called. These queries are created by the by* methods. Each instance also has a number of settings which can all be changed from their defaults via accessors, e.g. setBatchSize or setCaseSensitive. The only methods which are required for the proper functioning of a Search instance are:
- onlyType, onlyTypes OR allTypes
- Any by* method to create a query
Use of the allTypes method is discouraged, since it is possibly very resource intensive, which is why any attempt to receive results without specifically setting types or allowing all is prohibited.
See Also:

IQuery

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`activeQueries_async(AMD_Search_activeQueries __cb)` Returns the number of active queries.
`void`	`addOrderByAsc_async(AMD_Search_addOrderByAsc __cb, java.lang.String path)` A path from the target entity which will be added to the current stack of order statements applied to the query.
`void`	`addOrderByDesc_async(AMD_Search_addOrderByDesc __cb, java.lang.String path)` A path from the target entity which will be added to the current stack of order statements applied to the query.
`void`	`allTypes_async(AMD_Search_allTypes __cb)` Permits all types to be returned.
`void`	`and_async(AMD_Search_and __cb)` Applies the next by* method to the previous by* method, so that a call `hasNext`, `next`, or `results` sees only the intersection of the two calls.
`void`	`byAnnotatedWith_async(AMD_Search_byAnnotatedWith __cb, java.util.List<Annotation> examples)` Finds entities annotated with an `Annotation` similar to the example.
`void`	`byFullText_async(AMD_Search_byFullText __cb, java.lang.String query)` Passes the query as is to the Lucene backend.
`void`	`byGroupForTags_async(AMD_Search_byGroupForTags __cb, java.lang.String group)` Returns transient (without ID) `TagAnnotation` instances which represent all the `TagAnnotation` tags in the given group.
`void`	`byHqlQuery_async(AMD_Search_byHqlQuery __cb, java.lang.String query, Parameters params)` Delegates to `omero.api.IQuery.findAllByQuery` method to take advantage of the `and`, `or`, and `not` methods, or queue-semantics.
`void`	`byLuceneQueryBuilder_async(AMD_Search_byLuceneQueryBuilder __cb, java.lang.String fields, java.lang.String from, java.lang.String to, java.lang.String dateType, java.lang.String query)` Builds a Lucene query and passes it to the Lucene backend.
`void`	`bySimilarTerms_async(AMD_Search_bySimilarTerms __cb, java.util.List<java.lang.String> terms)` Returns transient (without ID) `TextAnnotation` instances which represent terms which are similar to the given terms.
`void`	`bySomeMustNone_async(AMD_Search_bySomeMustNone __cb, java.util.List<java.lang.String> some, java.util.List<java.lang.String> must, java.util.List<java.lang.String> none)` Builds a Lucene query and passes it to `byFullText`.
`void`	`byTagForGroups_async(AMD_Search_byTagForGroups __cb, java.lang.String tag)` Creates a query which will return transient (without ID) `TagAnnotation` instances which represent all the `TagAnnotation` tag groups which the given tag belongs to.
`void`	`clearQueries_async(AMD_Search_clearQueries __cb)` Removes all active queries (leaving `resetDefaults` settings alone), such that `activeQueries` will return 0.
`void`	`currentMetadata_async(AMD_Search_currentMetadata __cb)` Provides access to the extra query information (for example Lucene score and boost values) for a single call to `next`.
`void`	`currentMetadataList_async(AMD_Search_currentMetadataList __cb)` Provides access to the extra query information (for example Lucene score and boost values) for a single call to `results`.
`void`	`fetchAlso_async(AMD_Search_fetchAlso __cb, java.util.List<java.lang.String> fetches)` Adds a fetch clause for loading non-annotation fields of returned entities.
`void`	`fetchAnnotations_async(AMD_Search_fetchAnnotations __cb, java.util.List<java.lang.String> classes)` Queries the database for all `Annotation` annotations of the given types for all returned instances.
`void`	`getBatchSize_async(AMD_Search_getBatchSize __cb)` Returns the current batch size.
`void`	`hasNext_async(AMD_Search_hasNext __cb)` Returns `true` if another call to `next` is valid.
`void`	`isAllowLeadingWildcard_async(AMD_Search_isAllowLeadingWildcard __cb)` Returns the current leading-wildcard setting.
`void`	`isCaseSensitive_async(AMD_Search_isCaseSensitive __cb)` Returns the current case sensitivity setting.
`void`	`isMergedBatches_async(AMD_Search_isMergedBatches __cb)` Returns the current merged-batches setting.
`void`	`isReturnUnloaded_async(AMD_Search_isReturnUnloaded __cb)` Returns the current return-unloaded setting.
`void`	`isUseProjections_async(AMD_Search_isUseProjections __cb)` Returns the current use-projection setting.
`void`	`next_async(AMD_Search_next __cb)` Returns the next entity from the current query.
`void`	`not_async(AMD_Search_not __cb)` Applies the next by* method to the previous by* method, so that a call `hasNext`, `next`, or `results` sees only the intersection of the two calls.
`void`	`notAnnotatedBy_async(AMD_Search_notAnnotatedBy __cb, Details d)` Restricts entities by who has not annotated them with an `Annotation` matching the other filters.
`void`	`notOwnedBy_async(AMD_Search_notOwnedBy __cb, Details d)` Uses the `Details.getOwner()` and `Details.getGroup()` information to restrict the entities which will be returned.
`void`	`onlyAnnotatedBetween_async(AMD_Search_onlyAnnotatedBetween __cb, RTime start, RTime stop)` Restricts entities by the time in which any annotation (which matches the other filters) was added them.
`void`	`onlyAnnotatedBy_async(AMD_Search_onlyAnnotatedBy __cb, Details d)` Restricts entities by who has annotated them with an `Annotation` matching the other filters.
`void`	`onlyAnnotatedWith_async(AMD_Search_onlyAnnotatedWith __cb, java.util.List<java.lang.String> classes)` Restricts entities to having an `Annotation` of all the given types.
`void`	`onlyCreatedBetween_async(AMD_Search_onlyCreatedBetween __cb, RTime start, RTime stop)` Restricts the time between which an entity may have been created.
`void`	`onlyIds_async(AMD_Search_onlyIds __cb, java.util.List<java.lang.Long> ids)` Restricts the set of ids which will be checked.
`void`	`onlyModifiedBetween_async(AMD_Search_onlyModifiedBetween __cb, RTime start, RTime stop)` Restricts the time between which an entity may have last been modified.
`void`	`onlyOwnedBy_async(AMD_Search_onlyOwnedBy __cb, Details d)` Uses the `Details.getOwner()` and `Details.getGroup()` information to restrict the entities which will be returned.
`void`	`onlyType_async(AMD_Search_onlyType __cb, java.lang.String klass)` Restricts the search to a single type.
`void`	`onlyTypes_async(AMD_Search_onlyTypes __cb, java.util.List<java.lang.String> classes)` Restricts searches to a set of types.
`void`	`or_async(AMD_Search_or __cb)` Applies the next by* method to the previous by* method, so that a call `hasNext`, `next` or `results` sees only the union of the two calls.
`void`	`remove_async(AMD_Search_remove __cb)` Unsupported operation.
`void`	`resetDefaults_async(AMD_Search_resetDefaults __cb)` Resets all settings (non-query state) to the original default values, as if the instance had just be created.
`void`	`results_async(AMD_Search_results __cb)` Returns up to `getBatchSize` batch size number of results along with the related query metadata.
`void`	`setAllowLeadingWildcard_async(AMD_Search_setAllowLeadingWildcard __cb, boolean allowLeadingWildcard)` Permits full-text queries with a leading query if true.
`void`	`setBatchSize_async(AMD_Search_setBatchSize __cb, int size)` Sets the maximum number of results that will be returned by one call to `results`.
`void`	`setCaseSensitive_async(AMD_Search_setCaseSensitive __cb, boolean caseSensitive)` Sets the case sensitivity on all queries where case-sensitivity is supported.
`void`	`setCaseSentivice_async(AMD_Search_setCaseSentivice __cb, boolean caseSensitive)` Deprecated. use setCaseSensitive instead
`void`	`setMergedBatches_async(AMD_Search_setMergedBatches __cb, boolean merge)` Set whether or not results from two separate queries can be returned in the same call to `results`.
`void`	`setReturnUnloaded_async(AMD_Search_setReturnUnloaded __cb, boolean returnUnloaded)` Determines if all results should be returned as unloaded objects.
`void`	`setUseProjections_async(AMD_Search_setUseProjections __cb, boolean useProjections)` Determines if Lucene queries should not hit the database.
`void`	`unordered_async(AMD_Search_unordered __cb)` Removes the current stack of order statements.

Methods inherited from interface omero.api._StatefulServiceInterfaceOperationsNC
activate_async, close_async, getCurrentEventContext_async, passivate_async

- Method Detail
  - activeQueries_async
```
void activeQueries_async(AMD_Search_activeQueries __cb)
                  throws ServerError
```
    Returns the number of active queries. This means that activeQueries gives the minimum number of remaining calls to results when batches are not merged.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - setBatchSize_async
```
void setBatchSize_async(AMD_Search_setBatchSize __cb,
                        int size)
                 throws ServerError
```
    Sets the maximum number of results that will be returned by one call to results. If batches are not merged, then results may often be less than the batch size. If batches are merged, then only the last call to results can be less than batch size. Note: some query types may not support batching at the query level, and all instances must then be loaded into memory simultaneously.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    size - maximum number of results per call to results
    
    Throws:
    
    ServerError
  - getBatchSize_async
```
void getBatchSize_async(AMD_Search_getBatchSize __cb)
                 throws ServerError
```
    Returns the current batch size. If setBatchSize has not been called, the default value will be in effect.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - setMergedBatches_async
```
void setMergedBatches_async(AMD_Search_setMergedBatches __cb,
                            boolean merge)
                     throws ServerError
```
    Set whether or not results from two separate queries can be returned in the same call to results.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - isMergedBatches_async
```
void isMergedBatches_async(AMD_Search_isMergedBatches __cb)
                    throws ServerError
```
    Returns the current merged-batches setting. If setMergedBatches has not been called, the default value will be in effect.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - setCaseSentivice_async
```
void setCaseSentivice_async(AMD_Search_setCaseSentivice __cb,
                            boolean caseSensitive)
                     throws ServerError
```
    Deprecated. use setCaseSensitive instead
    
    Sets the case sensitivity on all queries where case-sensitivity is supported.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - setCaseSensitive_async
```
void setCaseSensitive_async(AMD_Search_setCaseSensitive __cb,
                            boolean caseSensitive)
                     throws ServerError
```
    Sets the case sensitivity on all queries where case-sensitivity is supported.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - isCaseSensitive_async
```
void isCaseSensitive_async(AMD_Search_isCaseSensitive __cb)
                    throws ServerError
```
    Returns the current case sensitivity setting. If setCaseSensitive has not been called, the default value will be in effect.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - setUseProjections_async
```
void setUseProjections_async(AMD_Search_setUseProjections __cb,
                             boolean useProjections)
                      throws ServerError
```
    Determines if Lucene queries should not hit the database. Instead all values which are stored in the index will be loaded into the object, which includes the id. However, the entity will not be marked unloaded and therefore it is especially important to not allow a projection-instance to be saved back to the server. This can result in DATA LOSS.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - isUseProjections_async
```
void isUseProjections_async(AMD_Search_isUseProjections __cb)
                     throws ServerError
```
    Returns the current use-projection setting. If true, the client must be careful with all results that are returned. See setUseProjections for more. If setUseProjections has not been called, the default value will be in effect.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - setReturnUnloaded_async
```
void setReturnUnloaded_async(AMD_Search_setReturnUnloaded __cb,
                             boolean returnUnloaded)
                      throws ServerError
```
    Determines if all results should be returned as unloaded objects. This is particularly useful for creating lists for further querying via IQuery. This value overrides the setUseProjections setting.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - isReturnUnloaded_async
```
void isReturnUnloaded_async(AMD_Search_isReturnUnloaded __cb)
                     throws ServerError
```
    Returns the current return-unloaded setting. If true, all returned entities will be unloaded. If setReturnUnloaded has not been called, the default value will be in effect.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - setAllowLeadingWildcard_async
```
void setAllowLeadingWildcard_async(AMD_Search_setAllowLeadingWildcard __cb,
                                   boolean allowLeadingWildcard)
                            throws ServerError
```
    Permits full-text queries with a leading query if true.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - isAllowLeadingWildcard_async
```
void isAllowLeadingWildcard_async(AMD_Search_isAllowLeadingWildcard __cb)
                           throws ServerError
```
    Returns the current leading-wildcard setting. If false, byFullText and bySomeMustNone will throw an ApiUsageException, since leading-wildcard searches are quite slow. Use setAllowLeadingWildcard in order to permit this usage.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - onlyType_async
```
void onlyType_async(AMD_Search_onlyType __cb,
                    java.lang.String klass)
             throws ServerError
```
    Restricts the search to a single type. All return values will match this type.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - onlyTypes_async
```
void onlyTypes_async(AMD_Search_onlyTypes __cb,
                     java.util.List<java.lang.String> classes)
              throws ServerError
```
    Restricts searches to a set of types. The entities returned are guaranteed to be one of these types.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - allTypes_async
```
void allTypes_async(AMD_Search_allTypes __cb)
             throws ServerError
```
    Permits all types to be returned. For some types of queries, this carries a performance penalty as every database table must be hit.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - onlyIds_async
```
void onlyIds_async(AMD_Search_onlyIds __cb,
                   java.util.List<java.lang.Long> ids)
            throws ServerError
```
    Restricts the set of ids which will be checked. This is useful for testing one of the given restrictions on a reduced set of objects.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    ids - Can be null, in which case the previous restriction is removed.
    
    Throws:
    
    ServerError
  - onlyOwnedBy_async
```
void onlyOwnedBy_async(AMD_Search_onlyOwnedBy __cb,
                       Details d)
                throws ServerError
```
    Uses the Details.getOwner() and Details.getGroup() information to restrict the entities which will be returned. If both are non-null, the two restrictions are joined by an AND.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    d - Can be null, in which case the previous restriction is removed.
    
    Throws:
    
    ServerError
  - notOwnedBy_async
```
void notOwnedBy_async(AMD_Search_notOwnedBy __cb,
                      Details d)
               throws ServerError
```
    Uses the Details.getOwner() and Details.getGroup() information to restrict the entities which will be returned. If both are non-null, the two restrictions are joined by an AND.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    d - Can be null, in which case the previous restriction is removed.
    
    Throws:
    
    ServerError
  - onlyCreatedBetween_async
```
void onlyCreatedBetween_async(AMD_Search_onlyCreatedBetween __cb,
                              RTime start,
                              RTime stop)
                       throws ServerError
```
    Restricts the time between which an entity may have been created.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    start - Can be null, i.e. interval open to negative infinity.
    
    stop - Can be null, i.e. interval opens to positive infinity.
    
    Throws:
    
    ServerError
  - onlyModifiedBetween_async
```
void onlyModifiedBetween_async(AMD_Search_onlyModifiedBetween __cb,
                               RTime start,
                               RTime stop)
                        throws ServerError
```
    Restricts the time between which an entity may have last been modified.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    start - Can be null, i.e. interval open to negative infinity.
    
    stop - Can be null, i.e. interval open to positive infinity.
    
    Throws:
    
    ServerError
  - onlyAnnotatedBetween_async
```
void onlyAnnotatedBetween_async(AMD_Search_onlyAnnotatedBetween __cb,
                                RTime start,
                                RTime stop)
                         throws ServerError
```
    Restricts entities by the time in which any annotation (which matches the other filters) was added them. This matches the Details.getCreationEvent() creation event of the Annotation.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    start - Can be null, i.e. interval open to negative infinity.
    
    stop - Can be null, i.e. interval open to positive infinity.
    
    Throws:
    
    ServerError
  - onlyAnnotatedBy_async
```
void onlyAnnotatedBy_async(AMD_Search_onlyAnnotatedBy __cb,
                           Details d)
                    throws ServerError
```
    Restricts entities by who has annotated them with an Annotation matching the other filters. As onlyOwnedBy, the Details.getOwner() and Details.getGroup() information is combined with an AND condition.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    d - Can be null, in which case any previous restriction is removed.
    
    Throws:
    
    ServerError
  - notAnnotatedBy_async
```
void notAnnotatedBy_async(AMD_Search_notAnnotatedBy __cb,
                          Details d)
                   throws ServerError
```
    Restricts entities by who has not annotated them with an Annotation matching the other filters. As notOwnedBy, the Details.getOwner() and Details.getGroup() information is combined with an AND condition.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    d - Can be null, in which case any previous restriction is removed.
    
    Throws:
    
    ServerError
  - onlyAnnotatedWith_async
```
void onlyAnnotatedWith_async(AMD_Search_onlyAnnotatedWith __cb,
                             java.util.List<java.lang.String> classes)
                      throws ServerError
```
    Restricts entities to having an Annotation of all the given types. This is useful in combination with the other onlyAnnotated* methods to say, e.g., only annotated with a file by user X. By default, this value is null and imposes no restriction. Passing an empty array implies an object that is not annotated at all. Note: If the semantics were OR, then a client would have to query each class individually, and compare all the various values, checking which ids are where. However, since this method defaults to AND, multiple calls (optionally with isMergedBatches and isReturnUnloaded) and combine the results. Duplicate ids are still possible so a set of some form should be used to collect the results.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    classes - Can be empty, in which case restriction is removed.
    
    Throws:
    
    ServerError
  - addOrderByAsc_async
```
void addOrderByAsc_async(AMD_Search_addOrderByAsc __cb,
                         java.lang.String path)
                  throws ServerError
```
    A path from the target entity which will be added to the current stack of order statements applied to the query.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    path - Non-null.
    
    Throws:
    
    ServerError
  - addOrderByDesc_async
```
void addOrderByDesc_async(AMD_Search_addOrderByDesc __cb,
                          java.lang.String path)
                   throws ServerError
```
    A path from the target entity which will be added to the current stack of order statements applied to the query.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    path - Non-null.
    
    Throws:
    
    ServerError
  - unordered_async
```
void unordered_async(AMD_Search_unordered __cb)
              throws ServerError
```
    Removes the current stack of order statements.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - fetchAnnotations_async
```
void fetchAnnotations_async(AMD_Search_fetchAnnotations __cb,
                            java.util.List<java.lang.String> classes)
                     throws ServerError
```
    Queries the database for all Annotation annotations of the given types for all returned instances.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    classes - Can be empty, which removes previous fetch setting.
    
    Throws:
    
    ServerError
  - fetchAlso_async
```
void fetchAlso_async(AMD_Search_fetchAlso __cb,
                     java.util.List<java.lang.String> fetches)
              throws ServerError
```
    Adds a fetch clause for loading non-annotation fields of returned entities. Each fetch is a hibernate clause in dot notation.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    fetches - Can be empty, which removes previous fetch setting.
    
    Throws:
    
    ServerError
  - resetDefaults_async
```
void resetDefaults_async(AMD_Search_resetDefaults __cb)
                  throws ServerError
```
    Resets all settings (non-query state) to the original default values, as if the instance had just be created.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - byGroupForTags_async
```
void byGroupForTags_async(AMD_Search_byGroupForTags __cb,
                          java.lang.String group)
                   throws ServerError
```
    Returns transient (without ID) TagAnnotation instances which represent all the TagAnnotation tags in the given group. The entities are transient and without ownership since multiple users can own the same tag. This method will override settings for types.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    group - Can be null or empty to return all tags.
    
    Throws:
    
    ServerError
  - byTagForGroups_async
```
void byTagForGroups_async(AMD_Search_byTagForGroups __cb,
                          java.lang.String tag)
                   throws ServerError
```
    Creates a query which will return transient (without ID) TagAnnotation instances which represent all the TagAnnotation tag groups which the given tag belongs to. The entities are transient and without ownership since multiple users can own the same tag group. This method will override settings for types.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    tag - Can be null or empty to return all groups.
    
    Throws:
    
    ServerError
  - byFullText_async
```
void byFullText_async(AMD_Search_byFullText __cb,
                      java.lang.String query)
               throws ServerError
```
    Passes the query as is to the Lucene backend.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    query - May not be null or of zero length.
    
    Throws:
    
    ServerError
  - byLuceneQueryBuilder_async
```
void byLuceneQueryBuilder_async(AMD_Search_byLuceneQueryBuilder __cb,
                                java.lang.String fields,
                                java.lang.String from,
                                java.lang.String to,
                                java.lang.String dateType,
                                java.lang.String query)
                         throws ServerError
```
    Builds a Lucene query and passes it to the Lucene backend.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    fields - The fields (comma separated) to search in (name, description, ...)
    
    from - The date range from, in the form YYYYMMDD (may be null)
    
    to - The date range to (inclusive), in the form YYYYMMDD (may be null)
    
    dateType - DATE_TYPE_ACQUISITION or DATE_TYPE_IMPORT
    
    query - May not be null or of zero length.
    
    Throws:
    
    ServerError
  - bySimilarTerms_async
```
void bySimilarTerms_async(AMD_Search_bySimilarTerms __cb,
                          java.util.List<java.lang.String> terms)
                   throws ServerError
```
    Returns transient (without ID) TextAnnotation instances which represent terms which are similar to the given terms. For example, if the argument is cell, one return value might have as its textValue: cellular while another has cellularize. No filtering or fetching is performed.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    terms - Cannot be empty.
    
    Throws:
    
    ServerError
  - byHqlQuery_async
```
void byHqlQuery_async(AMD_Search_byHqlQuery __cb,
                      java.lang.String query,
                      Parameters params)
               throws ServerError
```
    Delegates to omero.api.IQuery.findAllByQuery method to take advantage of the and, or, and not methods, or queue-semantics.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    query - Not null.
    
    Throws:
    
    ServerError
  - bySomeMustNone_async
```
void bySomeMustNone_async(AMD_Search_bySomeMustNone __cb,
                          java.util.List<java.lang.String> some,
                          java.util.List<java.lang.String> must,
                          java.util.List<java.lang.String> none)
                   throws ServerError
```
    Builds a Lucene query and passes it to byFullText.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    some - Some (at least one) of these terms must be present in the document. May be null.
    
    must - All of these terms must be present in the document. May be null.
    
    none - None of these terms may be present in the document. May be null.
    
    Throws:
    
    ServerError
  - byAnnotatedWith_async
```
void byAnnotatedWith_async(AMD_Search_byAnnotatedWith __cb,
                           java.util.List<Annotation> examples)
                    throws ServerError
```
    Finds entities annotated with an Annotation similar to the example. This does not use Hibernate's omero.api.IQuery.findByExample Query-By-Example} mechanism, since that cannot handle joins. The fields which are used are:
    - the main content of the annotation : String, IObject.getId(), etc.
    If the main content is null it is assumed to be a wildcard searched, and only the type of the annotation is searched. Currently, ListAnnotations are not supported.
    Parameters:
    
    __cb - The callback object for the operation.
    
    examples - Not empty.
    
    Throws:
    
    ServerError
  - clearQueries_async
```
void clearQueries_async(AMD_Search_clearQueries __cb)
                 throws ServerError
```
    Removes all active queries (leaving resetDefaults settings alone), such that activeQueries will return 0.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - and_async
```
void and_async(AMD_Search_and __cb)
        throws ServerError
```
    Applies the next by* method to the previous by* method, so that a call hasNext, next, or results sees only the intersection of the two calls. For example,
```
 
 service.onlyType(Image.class);
 service.byFullText(&quot;foo&quot;);
 service.intersection();
 service.byAnnotatedWith(TagAnnotation.class);
 
 
```
    will return only the Images with TagAnnotations.
    Calling this method overrides a previous setting of or or not. If there is no active queries (i.e. activeQueries > 0), then an ApiUsageException will be thrown.
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - or_async
```
void or_async(AMD_Search_or __cb)
       throws ServerError
```
    Applies the next by* method to the previous by* method, so that a call hasNext, next or results sees only the union of the two calls. For example,
```
 
 service.onlyType(Image.class);
 service.byFullText(&quot;foo&quot;);
 service.or();
 service.onlyType(Dataset.class);
 service.byFullText(&quot;foo&quot;);
 
 
```
    will return both Images and Datasets together. Calling this method overrides a previous setting of and or not. If there is no active queries (i.e. activeQueries > 0), then an ApiUsageException will be thrown.
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - not_async
```
void not_async(AMD_Search_not __cb)
        throws ServerError
```
    Applies the next by* method to the previous by* method, so that a call hasNext, next, or results sees only the intersection of the two calls. For example,
```
 
 service.onlyType(Image.class);
 service.byFullText(&quot;foo&quot;);
 service.complement();
 service.byAnnotatedWith(TagAnnotation.class);
 
 
```
    will return all the Images not annotated with TagAnnotation.
    Calling this method overrides a previous setting of or or and. If there is no active queries (i.e. activeQueries > 0), then an ApiUsageException will be thrown.
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - hasNext_async
```
void hasNext_async(AMD_Search_hasNext __cb)
            throws ServerError
```
    Returns true if another call to next is valid. A call to next may throw an exception for another reason, however.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - next_async
```
void next_async(AMD_Search_next __cb)
         throws ServerError
```
    Returns the next entity from the current query. If the previous call returned the last entity from a given query, the first entity from the next query will be returned and activeQueries decremented. Since this method only returns the entity itself, a single call to currentMetadata may follow this call to gather the extra metadata which is returned in the map via results.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ApiUsageException - if {code hasNext} returns false.
    
    ServerError
  - results_async
```
void results_async(AMD_Search_results __cb)
            throws ServerError
```
    Returns up to getBatchSize batch size number of results along with the related query metadata. If isMergedBatches batches are merged then the results from multiple queries may be returned together.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ApiUsageException - if hasNext returns false.
    
    ServerError
  - currentMetadata_async
```
void currentMetadata_async(AMD_Search_currentMetadata __cb)
                    throws ServerError
```
    Provides access to the extra query information (for example Lucene score and boost values) for a single call to next. This method may only be called once for any given call to next.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - currentMetadataList_async
```
void currentMetadataList_async(AMD_Search_currentMetadataList __cb)
                        throws ServerError
```
    Provides access to the extra query information (for example Lucene score and boost values) for a single call to results. This method may only be called once for any given call to results.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError
  - remove_async
```
void remove_async(AMD_Search_remove __cb)
           throws ServerError
```
    Unsupported operation.
    
    Parameters:
    
    __cb - The callback object for the operation.
    
    Throws:
    
    ServerError

Interface _SearchOperationsNC

Method Summary

Methods inherited from interface omero.api._StatefulServiceInterfaceOperationsNC

Method Detail

activeQueries_async

setBatchSize_async

getBatchSize_async

setMergedBatches_async

isMergedBatches_async

setCaseSentivice_async

setCaseSensitive_async

isCaseSensitive_async

setUseProjections_async

isUseProjections_async

setReturnUnloaded_async

isReturnUnloaded_async

setAllowLeadingWildcard_async

isAllowLeadingWildcard_async

onlyType_async

onlyTypes_async

allTypes_async

onlyIds_async

onlyOwnedBy_async

notOwnedBy_async

onlyCreatedBetween_async

onlyModifiedBetween_async

onlyAnnotatedBetween_async

onlyAnnotatedBy_async

notAnnotatedBy_async

onlyAnnotatedWith_async

addOrderByAsc_async

addOrderByDesc_async

unordered_async

fetchAnnotations_async

fetchAlso_async

resetDefaults_async

byGroupForTags_async

byTagForGroups_async

byFullText_async

byLuceneQueryBuilder_async

bySimilarTerms_async

byHqlQuery_async

bySomeMustNone_async

byAnnotatedWith_async

clearQueries_async

and_async

or_async

not_async

hasNext_async

next_async

results_async

currentMetadata_async

currentMetadataList_async

remove_async