Class ecm.model.SearchCriterion

Extends ecm.model._ModelObject.
Represents a set of criteria that is joined by AND/OR in a search.
Defined in: <ecm\model\SearchCriteria.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.SearchCriterion(properties) Constructs a search criteria object.

Field Summary

Field Attributes	Field Name and Description
	allowedValues  An array of values that can be assigned to the criterion.
	availableOperators  An array of operators used for defining search criteria.
	cardinality  The cardinality (SINGLE or MULTIPLE).
	choiceList  An array of values, and their labels, that can be assigned to the criterion.
	dataType  The data type of the values.
	defaultOperator  The default operator.
	defaultValue  The default value or values.
	description  The description of the attribute.
	format  The format applied to values.
	formatDescription  Returns a human-readable description of the format pattern.
	hasDependentAttributes  Indicates whether the criterion contains dependent attributes.
	hidden  Indicates whether the criterion is hidden.
	itemId  The criterion's identifier.
	markingList  A P8 marking list for the attribute.
	maxLength  The maximum length allowed for a string value.
	maxValue  The maximum value allowed.
	minLength  The minimum length allowed for a string value.
	minValue  The minimum value allowed.
	nullable  Indicates whether the attribute's value can be null.
	propertyEditor  A custom property editor widget class to use when creating an editor for the attribute within the ecm.widget.SinglePropertyEditorFactory.
	readOnly  Indicates whether the criterion is read-only.
	repositoryType  The type of repository that is associated with this criterion.
	searchTemplate  The instance of ecm.model._SearchTemplateBase that contains this criterion.
	selectedOperator  The current operator.
	textSearchable  Indicates whether the attribute is text-searchable.
	usesLongColumn  Indicates whether the attribute uses a long column (FileNet P8 only).
	value  The sole value or the first value in the array of values assigned to this criterion.
	valueFixed  Indicates whether the value is fixed (CMOD only).
	valueRequired  Indicates whether the criterion requires a non-empty value.
	values  An array of values assigned to this criterion.

Fields borrowed from class ecm.model._ModelObject:

categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes	Method Name and Description
	clone()
	equals(searchCriterion) Returns true if the other object is equal to this one.
	onValueChange() An event that is triggered when the value is modified.
	reset() Restores the default operator and value.
	resetValue() Restores the default value.
	setValues(values) Sets the values of this criterion.

Methods borrowed from class ecm.model._ModelObject:

destroy, getSortCriteria, onChange, own, refresh, toString

Field Detail

allowedValues

---

availableOperators

---

cardinality

---

choiceList

---

dataType

---

defaultOperator

---

defaultValue

---

description

Since:

2.0.2.3

---

format

---

formatDescription

Since:

3.0

---

hasDependentAttributes

---

hidden

---

itemId

---

markingList

---

maxLength

---

maxValue

---

minLength

Since:

2.0.3

---

minValue

---

nullable

Since:

2.0.3.1

---

propertyEditor

Since:

2.0.3.4

---

readOnly

---

repositoryType

Since:

2.0.2

---

searchTemplate

Since:

2.0.2

---

selectedOperator

---

textSearchable

Since:

2.0.3.1

---

usesLongColumn

Since:

2.0.3.1

---

value

Deprecated:

As of version 2.0.2. Use the first element of the values array, e.g., value = criterion.values && criterion.values.length ? criterion.values[0] : null.

---

valueFixed

---

valueRequired

---

values

Method Detail

clone()

---

equals(searchCriterion)

Parameters:

searchCriterion

A ecm.model.SearchCriterion object

---

onValueChange()

Since:

2.0.3

---

reset()

---

resetValue()

---

setValues(values)

Parameters:

values

An array of values

---