Class ecm.model._SearchMixin

An interface for models that provide search functionality.
Defined in: <ecm\model\_SearchMixin.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model._SearchMixin()

Field Summary

Field Attributes	Field Name and Description
	resultsDisplay An object holding the display settings for search results.

Method Summary

Method Attributes	Method Name and Description
	onSearchCompleted(results) Event fired when the search has completed running.
	search(callback, sortProperty, descending, teamspace, errorCallback) Runs the search.

Constructor Detail

ecm.model._SearchMixin()

Since:: 2.0.3

Field Detail

resultsDisplay

An object holding the display settings for search results. Available options:

sortBy: The ID of the property to sort by sortAsc: A Boolean indicating whether to sort search results in ascending order columns: An array of property identifiers representing the search result columns magazineColumns: An array of property identifiers representing the search result columns displayed in the magazine view honorNameProperty: A Boolean indicating whether to honor the label of the repository's designated name property (typically Document Title in FileNet P8) by showing it as-is on the column header or as the pseudo "Name" property showContentSummary: A Boolean indicating whether to enable content summaries in the magazine view (FileNet P8 text searches only)

Method Detail

onSearchCompleted(results)

Event fired when the search has completed running.

Parameters:
results: A ecm.model.ResultSet object

search(callback, sortProperty, descending, teamspace, errorCallback)

Runs the search.

Parameters:
callback: A function called with a {@ecm.model.ResultSet} object when the search has completed running
sortProperty: The ID of the attribute to sort by
descending: Specifies whether to sort the results in descending order
teamspace: An optional ecm.model.Teamspace object
errorCallback: A function called with the response object when the search fails