Class ecm.model._SearchTemplateBase

Extends ecm.model._ContentItem.
Base class for search templates, for example, ecm.model.SearchTemplate and ecm.model.UnifiedSearchTemplate
Defined in: <ecm\model\_SearchTemplateBase.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	andSearch  Indicates whether this search is configured to match all of the search criteria.
	autoResolved  Indicates whether invalid references were automatically resolved during search criteria retrieval.
	autoRun  Indicates whether this search is configured to run automatically when opened.
	cacheResults  A boolean value indicating whether to cache search results.
	description  The description of this search.
	invalidClass  A boolean value indicating whether the search from class is invalid.
	invalidFolder  A boolean value indicating whether the search folder is invalid.
	invalidProperty  A boolean value indicating whether a referenced property is invalid.
	invalidRepository  A boolean value indicating whether the search repository is invalid.
	parentFolderId  The ID of the folder in which to file the search when saved.
	searchConfig  A ecm.model.SearchConfiguration object.
	searchCriteria  An array of ecm.model.SearchCriterion objects.
	showInTree  Indicates whether this search is configured to be shown in the folder structure of the repository it is filed in.
	UUID  A universally unique ID that is used to distinguish cloned instances of the same search in the model.

Method Summary

Method Attributes	Method Name and Description
	clone() Returns a clone of this search.
	containsEqualCriteria(searchTemplate) Returns true if the criteria of the specified search is equal to this ones.
	equals(object) Returns true if the other object represents the same item as this one.
	generateUUID() Returns an UUID for this search.
	isAttributeHidden(attributeId) Return true if the given attribute is hidden.
	isAutoRun() Returns true if this search is configured to run automatically when opened.
	isLoaded() Return true if this search has been loaded from the repository.
	isNavigatorSavedSearch() Returns true if this search was built in Content Navigator.
	isNew() Returns true if this search has not been saved.
	isShowInTree() Returns true if this search is configured to be shown in the folder structure of the repository it is filed in.
	onSearchCompleted(results) Overrides ecm.model._SearchMixin.onSearchCompleted to cache the results.
	onSearchCriteriaRetrieved(searchTemplate) Event fired when the search criteria has been retrieved.
	onUnsupportedSearchCriteriaRetrieved(searchTemplate) Event fired when unsupported search criteria is retrieved.
	refresh() Overrides ecm.model.Contentitem.refresh to clear cached results.
	retrieveSearchCriteria(callback, editMode, teamspaceId, refresh, autoResolve, synchronous, version, errorCallback) Retrieve the search criteria for this search template
	save(callback) Saves this search in the repository.
	search(callback, sortProperty, descending, teamspace, errorCallback, useCache) Runs the search.
	toJson() Returns the JSON representation of this search.

Field Detail

andSearch

---

autoResolved

---

autoRun

---

cacheResults

Since:

3.0.10

---

description

---

invalidClass

---

invalidFolder

---

invalidProperty

---

invalidRepository

---

parentFolderId

---

searchConfig

---

searchCriteria

---

showInTree

---

UUID

Method Detail

clone()

---

containsEqualCriteria(searchTemplate)

Parameters:

searchTemplate

An instance of ecm.model._SearchTemplateBase

---

equals(object)

Parameters:

object

An object

---

generateUUID()

---

isAttributeHidden(attributeId)

Parameters:

attributeId

The ID of the attribute

---

isAutoRun()

---

isLoaded()

Since:

2.0.2

---

isNavigatorSavedSearch()

---

isNew()

---

isShowInTree()

---

onSearchCompleted(results)

Parameters:

results

---

onSearchCriteriaRetrieved(searchTemplate)

Parameters:

searchTemplate

An instance of ecm.model._SearchTemplateBase

---

onUnsupportedSearchCriteriaRetrieved(searchTemplate)

Parameters:

searchTemplate

An instance of ecm.model._SearchTemplateBase

---

refresh()

---

retrieveSearchCriteria(callback, editMode, teamspaceId, refresh, autoResolve, synchronous, version, errorCallback)

Parameters:

callback

A callback function to be called after the search criteria has been retrieved

editMode

A string value indicating the edit mode of the criteria (ie. "edit" or "search")

teamspaceId

A string value hold the teamspace id if search is scoped to a teamspace (maybe null).

refresh

A boolean value indicating whether the search should use cached criteria (if it exists)

autoResolve

A flag indicating whether the criteria supports automatic resolution

synchronous

Indicates whether the criteria is retrieved synchronously

version

The version to be retrieved, i.e., "current", "released", or "specific" (optional). If not specified or editMode is "edit", the released version is retrieved.

errorCallback

A callback function to be invoked when an error occurs

---

save(callback)

Parameters:

callback

A callback function to be invoked with the updated search

---

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

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

useCache

A boolean value indicating whether to use cached results if they are available and the criteria has not changed since the last search

Returns:

A ecm.model.Request object or null if the results are retrieved from cache

---

toJson()

---