Class ecm.model.SearchClass


Extends ecm.model._ModelObject.
Represents a search class and holds the extra meta data that would be defined with a content class to be used in a search.
Defined in: <ecm\model\SearchClass.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
ecm.model.SearchClass(properties)
Constructor

Field Summary

Field Attributes Field Name and Description
 
A string value holding the ecm.model.SearchClass.EDIT_PROPERTY setting
 
itemId 
A string value holding the item id
 
A string value holding the search class object type
 
A boolean value indicating whether the search is defined to search sub-classes
 
A boolean value indicating whether the search class is selected or not.
Fields borrowed from class ecm.model._ModelObject:
categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes Method Name and Description
 
equals(searchClass)
Equality operator for comparing search class objects
 
Returns a boolean value indicating whether this search class is hidden.
 
Returns a boolean value indicating whether this search class is read only.
Methods borrowed from class ecm.model._ModelObject:
destroy, onChange, own, refresh, toString

Constructor Detail

ecm.model.SearchClass(properties)

Constructor
Parameters:
properties
The properties for the model object. The properties can be any of the public fields as defined below and on ecm.model._ModelObject.

Field Detail

editProperty

A string value holding the ecm.model.SearchClass.EDIT_PROPERTY setting

itemId

A string value holding the item id

objectType

A string value holding the search class object type

searchSubclasses

A boolean value indicating whether the search is defined to search sub-classes

selected

A boolean value indicating whether the search class is selected or not.

Method Detail

equals(searchClass)

Equality operator for comparing search class objects
Parameters:
searchClass
A ecm.model.SearchClass object to compare

isHidden()

Returns a boolean value indicating whether this search class is hidden.

isReadOnly()

Returns a boolean value indicating whether this search class is read only.