Class ecm.model.SearchCriterion
Extends
ecm.model._ModelObject.
Represents a field in a search template. The information this class defines include the field name,
supported operators, initial value, and allowed values. This class also supports setting the operator and
values when a user fills in a search template.
Defined in: <ecm\model\SearchCriterion.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
ecm.model.SearchCriterion(properties)
Constructs a search criterion.
|
Field Summary
Field Attributes | Field Name and Description |
---|---|
An array of values that can be assigned to the criterion.
|
|
An array of operators used for defining search criteria.
|
|
The cardinality (SINGLE or MULTIPLE).
|
|
An array of values, and their labels, that can be assigned to the criterion.
|
|
The data type of the values.
|
|
The default operator.
|
|
The default value or values.
|
|
The description of the attribute.
|
|
The format applied to values.
|
|
Indicates whether the criterion contains dependent attributes.
|
|
Indicates whether the criterion is hidden.
|
|
The criterion's identifier.
|
|
A P8 marking list for the attribute.
|
|
The maximum length allowed for a string value.
|
|
The maximum value allowed.
|
|
The minimum length allowed for a string value.
|
|
The minimum value allowed.
|
|
Indicates whether the attribute's value can be null.
|
|
A custom property editor widget class to use when creating an editor for the attribute within the
ecm.widget.SinglePropertyEditorFactory.
|
|
Indicates whether the criterion is read-only.
|
|
The type of repository that is associated with this criterion.
|
|
The instance of ecm.model._SearchTemplateBase that contains this criterion.
|
|
The current operator.
|
|
Indicates whether the attribute is text-searchable.
|
|
Indicates whether the attribute uses a long column (FileNet P8 only).
|
|
The sole value or the first value in the array of values assigned to this criterion.
|
|
Indicates whether the value is fixed (CMOD only).
|
|
Indicates whether the criterion requires a non-empty value.
|
|
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.
|
|
An event that is triggered when the value is modified.
|
|
reset()
Restores the default operator and value.
|
|
Restores the default value.
|
|
setValues(values)
Sets the values of this criterion.
|
Constructor Detail
ecm.model.SearchCriterion(properties)
Constructs a search criterion.
- Parameters:
- properties
- The properties for the search criterion. The properties can be any of the public fields as defined below and on ecm.model._ModelObject.
Field Detail
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.
- Since:
- 2.0.2.3
format
The format applied to values.
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.
- Since:
- 2.0.3
minValue
The minimum value allowed.
nullable
Indicates whether the attribute's value can be null.
- Since:
- 2.0.3.1
propertyEditor
A custom property editor widget class to use when creating an editor for the attribute within the
ecm.widget.SinglePropertyEditorFactory. For example: "mywidgets/MyPropertyEditor"
- Since:
- 2.0.3.4
readOnly
Indicates whether the criterion is read-only.
repositoryType
The type of repository that is associated with this criterion.
- Since:
- 2.0.2
searchTemplate
The instance of ecm.model._SearchTemplateBase that contains this criterion.
- Since:
- 2.0.2
selectedOperator
The current operator.
textSearchable
Indicates whether the attribute is text-searchable.
- Since:
- 2.0.3.1
usesLongColumn
Indicates whether the attribute uses a long column (FileNet P8 only).
- Since:
- 2.0.3.1
value
The sole value or the first value in the array of values assigned to this criterion. This field should not be
updated directly, use the setValues method instead.
- 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
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. This field should not be updated directly, use the setValues
method instead.
Method Detail
clone()
equals(searchCriterion)
Returns true if the other object is equal to this one.
- Parameters:
- searchCriterion
- A ecm.model.SearchCriterion object
onValueChange()
An event that is triggered when the value is modified.
- Since:
- 2.0.3
reset()
Restores the default operator and value.
resetValue()
Restores the default value.
setValues(values)
Sets the values of this criterion.
- Parameters:
- values
- An array of values