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
 

Field Summary

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

Method Summary

Method Attributes Method Name and Description
 
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.

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