This namespace provides local and remote search operations.

Classes

  ClassDescription
IncomingSearchQuery
Class responsible for performing searches from remote users and managing the results.
RemoteUserSearch
RemoteUserSearch is a WebService that provides an API for remote clients to search for publicly available items on this node.
SavedSearch
Represents an active search in the system. A SavedSearch object is created when a user initiates a search. It contains the time it was initiated, as well as the search criteria (keywords, extents etc). If remote nodes were also included, information relating to the number of nodes that have responded is available.
Search
Manages all search queries in the system.
SearchRequest
This class has two functions:
  • to encapsulate the search parameters for an outgoing (remote search).
  • to decipher the search parameters for an incoming search.
SearchResult
Encapsulates an individual result that was returning from a remote server.
SearchResultSet
A specialized collection that represents all the search results that belong to a particular SavedSearch.
SearchServiceJob
Represents an outgoing search request to a particular PhoenixNode and provides a mechanism to attach the results that come back.
SearchServiceRequest
Used to pass remote search requests from a client to the PhoenixSearchService.

Structures

  StructureDescription
SearchCapabilities
Provides a place to access various properties regarding the search capabilities of this node.

Enumerations

  EnumerationDescription
SavedSearch..::.SearchState
Indicates what state the search is currently in.
SearchResultFormats
Indicates how much metadata to include in the search result set.