ISYSResultList

<a name="kanchor487"></a>ISYSResultList Object

ISYSResultList contains a list of documents that match the search criteria.

ISYSResultList Methods

Item	Returns the ISYSDocument object for the document at the given index.
Load	Loads a previously saved result list stored by the Save method, replacing the current result list.
LoadFromFile	Loads a previously saved result list from a file created by the SaveToFile method, replacing the current result list.
PerformEnglishFind	Execute a Plain English sub-query within the current result list. The search will take place within the set of documents in the existing result list with the new results replacing the old.
PerformFind	Execute a sub-query within the current result list. The search will take place within the set of documents in the existing result list with the new results replacing the old. This allows you to drill down in your search strategy.
Prepare	Prepares the specified range of the result list. This will force the given range to be authenticated.
RemoveDocument	Remove the specified document from the result list. This function can be used to implement your own security on the result list.
RemoveUnauthorized	Scans the result list and removes documents that the current NT user does not have permission to view.
RemoveUnauthorizedEx	Scans a range of the result list and removes documents that the current NT user does not have permission to view.
Save	Saves the result list to a temporary file on disk and returns an identifier that can be used to reload the result list at a latter date. The format of the identifier is dependant on configuration.
SaveRange	Saves only the documents in the given range to disk.
SaveToFile	Saves the result list to a named file on disk for reloading at a later time via ISYSIndex::LoadResultList. It differs from Save as you must supply the filename.
SaveUpdates	The SaveUpdates method differs from the Save method in that it will re-use the existing Search ID if one is present. If there is not Search ID, a new one is generated.
Sort	Sort the result list by the specified criterion.
Truncate	Truncates the result list to the specified size. Only the truncated portion of the result list will be persisted to disk.

ISYSResultList Properties

Categories	Returns the categories that are applicable to the documents in the result list.
Clusters	Returns the hierarchical clusters for this search results.
DifferentWords	Returns the number of distinct words found for this search. This takes into account conflation and synonyms. Read-Only.
Document	Returns the ISYSDocument object for the document at the given index, same as Item. Read-Only.
Entities	Returns a read-only summary of the entities present in this result list. Entities must be enabled on the index.
Error	Return any error information that occurred while the result list was executing. This can include query parsing errors.
Expires	Specifies when the temporary result list should be cleaned up.
Filter	Applies a file name filter or date filter to the result list. If you make multiple calls, subsequent filters replace existing filters; they do not accumulate. The filter is saved and reloaded when persisting the result list to disk.
Filtered	Indicates if the result list is currently being filtered. Read-Only.
Groups	Returns the groups valid for this result list. Read-Only.
ID	Returns the current or allocates a new result list. Format of Search ID is dependant on configuration.
Index	Returns the index that was used to produce this result list.
IsFederated	Returns true if the current search result as the result of a federated search.
Length	Returns the number of documents in the result list, adjusted for sub-queries and filters. Read-Only.
Metadata	Returns the parametric refinement options for this result list.
NumberDocs	Returns the number of found documents in the result list. Same as length. Read-Only.
QueryExpansion	Returns a list of alternate queries calculated from the search results.
QueryString	Returns the text of the query used to produce the result list. Read-Only.
ReadyState	Returns the ready state of the result list, use when performing an asynchronous federated search.
RealTotal	Contains the total number of documents found, before any filtering, truncation or security checks have occurred. Read-Only.
SearchTerms	Returns the search terms valid for this result list, this list can be used to maintain hit color information. Read-Only.
ServerStatus	Returns status information about all servers involved with this search.
SortOrder	Get or set the current sort order of the result list
Statistics	Returns information about search token statistics. It contains information about each token searched on, allowing for wildcards, synonyms, conflation and thesaurus.
Stats	Returns the word statistics for the current search. The text is delimitered by carriage returns and tabs. Read-Only.
Store	Store values with the result list that are persisted with the result list.
Suggestion	Returns alternate query suggestions based on the last query.
TotalHits	Returns the total number of word hits found in the result list. Read-Only.

See Also

ISYSSearch