Plumtree EDK (Enterprise Web Development Kit) 5.4.0 |

# Plumtree.Remote.Search Namespace

Provides interfaces for creating remote search services for the Plumtree Corporate Portal.

Search services provide access to external repositories without adding documents to the Knowledge Directory. Search services are especially useful for content that changes frequently or is only accessed by a small number of portal users. Search services are a way to make content accessible to portal users without adding documents to your portal Knowledge Directory.

In this version of the EDK, search functionality is implemented using remote services. Using the EDK, you can create remote search services that access a range of back-end systems.

See Search Example

For examples, developer discussions and additional documentation, see Plumtree Developer Center

Namespace hierarchy

### Classes

Class | Description
--- | ---
RemoteSearchRecord | Bean implementation of `ISearchRecord`.
SearchConstants | Constants for error codes. If one of these constants is used in `ISearchResult.SetResultCode`, a link to the appropriate preferences page will be displayed.
SearchException | Class to pass known search exceptions and user-defined messages to the search interface in the portal.
TypeSearchError | Type-safe enumeration of error types.

### Interfaces

Interface | Description
--- | ---
IRemoteSearch | An interface to enable the Portal to execute searches on remote systems. This interface delivers search results based on specific inputs from the Portal. See Search Example
ISearchContext | An interface that provides a way to connect to the portal via the Plumtree Remote Client (PRC).
ISearchQuery | An interface that provides the input information to execute the search. For example, remote system access information, query strings, as well as search output preferences, including the number of records to be skipped.
ISearchRecord | A bean-type interface for an individual search record.
ISearchResult | An interface that represents search results.
ISearchUser | An interface that provides user-related information to enable the retrieval of results authorized and personalized for the user.