com.ansys.ingress.client.api.search

## Class RepositorySearch

- java.lang.Object
- - com.ansys.ingress.commons.search.Search<RepositorySearchResult>
  - - com.ansys.ingress.client.api.search.RepositorySearch

-     public abstract class RepositorySearch
      extends com.ansys.ingress.commons.search.Search<RepositorySearchResult>

  RepositorySearch is a search executed on the EKM server.

- - ### Field Summary

    - ### Fields inherited from class com.ansys.ingress.commons.search.Search

      `advancedSearchUserInput, asynchronous, log, path`

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `RepositorySearch()`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | `executeSearch()`
    `protected void` | `executeSearch(boolean limitResults)`
    `protected abstract java.util.Set<ModelObject>` | `findByQuery(java.lang.String query)` Sends the query to the EKM server and returns the results.
    `protected abstract java.util.Set<ModelObject>` | `findByQueryExpression(java.lang.String queryExpression)` Sends the query expression to the EKM server and returns the results.
    `protected com.ansys.ingress.commons.search.SearchResultComparator<RepositorySearchResult>` | `getComparatorInstance()`
    `void` | `setPath(java.lang.String path)` Sets the path to be searched.

    - ### Methods inherited from class com.ansys.ingress.commons.search.Search

      `addListener, execute, execute, getAdvancedSearchUserInput, getFullTextSearchUserInput, getMultiRepositorySearchUserInput, getQuery, getResultIterator, getResultSet, getResultSet, isAsynchronous, notifyListeners, removeListener, setAdvancedSearchUserInput, setAsynchronous, setFullTextQuery, setFullTextSearchUserInput, setIterator, setMultiRepositorySearchUserInput, setQuery, toString`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### RepositorySearch

          public RepositorySearch()

  - ### Method Detail

    - #### setPath

          public void setPath(java.lang.String path)

      Sets the path to be searched.
      Parameters:
        `path` - the path

    - #### executeSearch

          protected void executeSearch()

      Specified by:
        `executeSearch` in class `com.ansys.ingress.commons.search.Search<RepositorySearchResult>`

    - #### executeSearch

          protected void executeSearch(boolean limitResults)

      Specified by:
        `executeSearch` in class `com.ansys.ingress.commons.search.Search<RepositorySearchResult>`

    - #### getComparatorInstance

          protected com.ansys.ingress.commons.search.SearchResultComparator<RepositorySearchResult> getComparatorInstance()

      Specified by:
        `getComparatorInstance` in class `com.ansys.ingress.commons.search.Search<RepositorySearchResult>`

    - #### findByQuery

          protected abstract java.util.Set<ModelObject> findByQuery(java.lang.String query)
                                                             throws DataException

      Sends the query to the EKM server and returns the results.
      Parameters:
        `query` - the query
      Returns:
        Returns the objects that match the query or an empty set if no objects match the query.
      Throws:
        `DataException` - if an error occurs executing the query.

    - #### findByQueryExpression

          protected abstract java.util.Set<ModelObject> findByQueryExpression(java.lang.String queryExpression)
                                                                       throws DataException

      Sends the query expression to the EKM server and returns the results.
      Parameters:
        `queryExpression` - the query expression
      Returns:
        Returns the objects that match the query or an empty set if no objects match the query.
      Throws:
        `DataException` - if an error occurs executing the query.