Taxonomy (Component)

A taxonomy allow users to associate pages with a term in a taxonomy. With these associations in place, it is then possible to search, navigate, and filter pages based on this criteria. After a taxonomy is created or imported, a new field type becomes available for Simple Forms, Custom Elements, and Metadata Forms. This field type allows users to associate CommonSpot data with a term in the taxonomy. Methods in the Taxonomy objects can, for example, import, save, publish, validate, and delete taxonomies. Methods also exist for obtaining information about taxonomies and the items in the taxonomy.

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

Customization is not supported for this component.

Methods:

activate [L]	Activates a taxonomy.
delete [L]	Deletes a taxonomy.
discard [L]	Discards the Work in Progress changes to a taxonomy.
getList	Returns zero or more structures, each containing information on a taxonomy; for example, 'Name', 'Description', 'Version', and so on.
getTerms	Returns zero or more structures, each containing information about a taxonomy's terms; for example, 'AnnotationCount', 'FacetName', 'TermName', and so on.
getTermsByTermIDs	Returns the Taxonomy term for given Taxonomy ID, termID.
import [L]	Imports a taxonomy's file.
publish [L]	Publishes a taxonomy's Work in Progress changes.
validate	Returns a structure containing the results from CommonSpot validating an XML file or URL. Use this method before using the import() method. The elements of this structure are 'isValid' and 'Message'.