Search (Component)

The Search object manages the indexes that CommonSpot creates for information on pages. For example, you can create, enable, optimize, reindex, and validate search index collections. Other methods return information about collections.

Methods marked below with [L] may be logged at the site level (if transaction logging is licensed and enabled by the administrator)

Methods marked below with [C] may be customized at the site level

Methods:

createCollection [L] [C]	Creates a new full-text search collection within a parent directory. The subsites and perhaps their child subsites, if specified, will be associated with this collection.
deleteCollection [L] [C]	Deletes the specified collection. Any subsites bound to the collection will be removed from full text search, unless reassigned to another collection before deleting.
getAvailableCollections [C]	Returns query containing names of all existing collections which are or can be assigned to the current site.
getCollectionsInfo [C]	Returns zero or more structures, each containing information on a search collection and its status.
getCollectionsList [C]	Returns zero or more structures, each containing information on this site's search collections.
getCollectionSubsites [C]	Returns one or more structures, each containing information on a collection's subsites, as follows: the subsite's ID and its URL.
getCollectionUsage [C]	Returns a collection of object records (subsites and custom elements) which use the specified collection. If the collection name is empty, returns object records for subsites/custom elements which do not have an assigned full-text collection.
getSubsiteSettings [C]	Returns a structure whose members contain a subsite's search settings.
isEnabled [C]	Returns a Boolean flag which when true indicates that the full text search capability is enabled for this site.
optimizeCollection [L] [C]	Optimizes one or more full-text search collections.
reindexSubsites [L] [C]	Reindexes one or more specified subsites.
setCustomElementCollection [L] [C]	Assigns the specified collection to the specified custom element type(s).
setObjectCollection [L] [C]	Assigns the specified collection to the given subsites and/or custom element types.
setSubsiteCollection [L] [C]	Sets the full text search collection for the specified subsites.
testCollection [C]	Returns 'OK' if the collection tests ok, or an error message if not.
validateNewCollectionInfo [C]	Validates that the given name is valid as a new collection name. Returns a structure with the results.