com.softwareag.centrasite.api.csom
Interface Category

All Superinterfaces:
CentraSiteObject, CentraSiteRegistryObject

public interface Category
extends CentraSiteRegistryObject

The Category interface is used to represent taxonomy elements and their structural relationship with each other in order to describe an internal taxonomy. Category instances are used to define tree structures where the root of the tree is a Taxonomy instance and each node in the tree is a Category instance. Supported operations:

  • getChildCategoryCount
  • getChildCategories
  • getDescendantCategories
  • getTaxonomy
  • getParent
  • getPath
  • getValue

    Created by IntelliJ IDEA. User: rohit Date: 3/12/12 Time: 1:19 PM


    Method Summary
     java.lang.String getCanonicalPath()
              Gets the canonical path representation for this Category.
     java.util.Collection<Category> getChildCategories()
              Gets all immediate children Categories.
     int getChildCategoryCount()
              Gets number of children.
     java.util.Collection<Category> getDescendantCategories()
              Gets all descendant Categories.
     CentraSiteRegistryObject getParent()
              Gets the parent Category or Taxonomy for this object.
     java.util.List<CentraSiteRegistryObject> getPathObjects()
              Gets easy access to the categories/taxonomy that are on the path from a given category to the root of the taxonomy.
     Taxonomy getTaxonomy()
              Gets the Taxonomy that this Category is a descendant of.
     java.lang.String getValue()
              Gets the value (usually a code in a taxonomy) associated with this Category.
     
    Methods inherited from interface com.softwareag.centrasite.api.csom.CentraSiteRegistryObject
    getConsumers, getDescription, getDescription, getDisplayVersion, getLCMAssignment, getLocalName, getMandatoryAttributeProfiles, getName, getName, getNameSpace, getNextVersion, getNextVersions, getOrganization, getOwner, getPreviousVersion, getPreviousVersions, getRegistryObject, getSubscribers, getSystemVersion, getUserVersion, getVisiblePrimaryProfiles, isLatestVersionObject, setDescription, setDescription, setDisplayVersion, setLCMState, setLocalName, setName, setName, setNameSpace, setOrganization, setOwner, setUserVersion
     
    Methods inherited from interface com.softwareag.centrasite.api.csom.CentraSiteObject
    delete, getAttributeLink, getAttributeValue, getAttributeValue, getAttributeValue, getId, getType, isModified, isReadOnly, save, setAttributeValue, setAttributeValue, setAttributeValue
     

    Method Detail

    getChildCategoryCount

    int getChildCategoryCount()
                              throws CLLException
    Gets number of children.

    Returns:
    the number of children Categories
    Throws:
    CLLException - If fetch encounters an internal error

    getChildCategories

    java.util.Collection<Category> getChildCategories()
                                                      throws CLLException
    Gets all immediate children Categories.

    Returns:
    Collection of Category instances. The Collection may be empty but not null.
    Throws:
    CLLException - If fetch encounters an internal error

    getDescendantCategories

    java.util.Collection<Category> getDescendantCategories()
                                                           throws CLLException
    Gets all descendant Categories.(any level)

    Returns:
    Collection of Category instances. The Collection may be empty but not null.
    Throws:
    CLLException - If fetch encounters an internal error

    getTaxonomy

    Taxonomy getTaxonomy()
                         throws CLLException
    Gets the Taxonomy that this Category is a descendant of.

    Returns:
    Parent Taxonomy
    Throws:
    CLLException - CLLException If fetch encounters an internal error

    getPathObjects

    java.util.List<CentraSiteRegistryObject> getPathObjects()
                                                            throws CLLException
    Gets easy access to the categories/taxonomy that are on the path from a given category to the root of the taxonomy.

    Returns:
    Collection of CentraSiteRegistryObject encountered in the path(ordered by bottom up). Last element would be the immediate parent First element in the collection would be taxonomy(if exists).
    Throws:
    CLLException - If fetch encounters an internal error

    getCanonicalPath

    java.lang.String getCanonicalPath()
                                      throws CLLException
    Gets the canonical path representation for this Category.

    Returns:
    Gets the canonical path representation for this Category.
    Throws:
    CLLException - If fetch encounters an internal error

    getParent

    CentraSiteRegistryObject getParent()
                                       throws CLLException
    Gets the parent Category or Taxonomy for this object.

    Returns:
    the Category/Taxonomy that is the parent of this object
    Throws:
    CLLException - If fetch encounters an internal error

    getValue

    java.lang.String getValue()
                              throws CLLException
    Gets the value (usually a code in a taxonomy) associated with this Category.

    Returns:
    the value (usually a taxonomy value) associated with this Category
    Throws:
    CLLException - If fetch encounters an internal error