Classes
Type | Class | Description |
---|---|---|
![]() | SearchScope |
Determines which repository or repositories are to be searched, and supplies methods to
execute searches for properties, objects, and class metadata (class descriptions).
When multiple repositories are to be searched, use the SearchScope(objectStores, mergeMode) constructor to specify whether the scope is the union or intersection of the object stores. |
![]() | SearchSQL |
A helper class used to assist in building valid SQL statements.
An instance of this class is passed in to the SearchScope.FetchObjects and SearchScope.FetchRows methods to perform a query. The SearchSQL class can be used in either of the following ways:
The settings for the following properties can directly affect the search criteria:
![]() |
![]() | SearchTemplateContent |
Identifies the content search settings in a search template that can be modified for runtime purposes,
and enables you to choose whether the search template settings or the property values specified for this class are
to be used for the search.
The SearchTemplate* classes (those classes prefixed with "SearchTemplate") enable you to control and specify runtime modification of search template data. |
![]() | SearchTemplateContentItem |
Identifies the content search item settings in a search template that can be modified or excluded for runtime purposes,
and enables you to choose whether the search template settings or the property values specified for this class are
to be used for the search.
The SearchTemplate* classes (those classes prefixed with "SearchTemplate") enable you to control and specify runtime modification of search template data. |
![]() | SearchTemplateFolder |
Identifies the folder in a search template that is to be modified or excluded, or a new folder that is to be
added to the search. Methods are provided to supply new values to a folder being modified.
The SearchTemplate* classes (those classes prefixed with "SearchTemplate") enable you to control and specify runtime modification of search template data. |
![]() | SearchTemplateParameters |
Identifies the search parameters in the search template that can be modified, excluded or added to for runtime
purposes, and enables you to choose whether the search template settings or the property values specified for
this class are to be used for the search. The search parameters specified for an instance of this class are
used for execution of the Stored Search query by a SearchScope object.
The SearchTemplate* classes (those classes prefixed with "SearchTemplate") enable you to control and specify runtime modification of search template data. |
![]() | SearchTemplateSelectProperty |
Identifies the select list property in a search template that is to be modified or excluded, or a new select
list property that is to be added to the search. Methods are provided to supply new values to a select list
property being modified.
The SearchTemplate* classes (those classes prefixed with "SearchTemplate") enable you to control and specify runtime modification of search template data. |
![]() | SearchTemplateSubclass |
Identifies the subclass in a search template that is to be modified or excluded, or a new subclass
that is to be added to the search. Methods are provided to supply new values to a subclass
being modified.
The SearchTemplate* classes (those classes prefixed with "SearchTemplate") enable you to control and specify runtime modification of search template data. |
![]() | SearchTemplateWhereProperty |
Identifies the Where properties in a search template that can be modified or excluded for runtime
purposes, and enables you to choose whether the search template settings or the property values specified for
this class are to be used for the search.
The SearchTemplate* classes (those classes prefixed with "SearchTemplate") enable you to control and specify runtime modification of search template data. |
Interfaces
Type | Interface | Description |
---|---|---|
![]() | IRepositoryRow |
Used by search operations to access rows from the repository database. Each
row contains a collection of properties, returned as a Properties object.
A RepositoryRow object is similar to an EngineObject object. However, a RepositoryRow object cannot be used for updates, and it may contain multiple, identical properties. For example, each RepositoryRow object in the RepositoryRowSet collection returned as the result of the query "select Id as x, Creator as x from Document" would have two copies of the property "x". In this case, you would need to use the IProperties.ToArray method to get both values. |
![]() | IStoredSearch |
Represents the XML query for a stored search or search template. These search criteria are persisted to an object store.
Note: StoredSearch instances are available for use only when the Stored Search Extensions add-on is installed. A StoredSearch object is identified as a stored search or a search template through the setting of the SearchType property. A stored search or search template can be used to query for the object types: Document, CustomObject, or Folder. The SearchingObjectType property identifies the object type for the query. Only one object type can be specified per search clause. Each search clause specified in the XML must be handled as an individual query, requiring a separate call to the SearchScope method to execute each search clause. |