Package com.ptc.windchill.csm.service

Class ClassificationStructureServiceHelper

java.lang.Object
com.ptc.windchill.csm.service.ClassificationStructureServiceHelper
public class ClassificationStructureServiceHelper extends Object
Provides supported APIs for Classification CRUD operations

Supported API: true

Extendable: false

  • Method Details

    • createNode

      public static ClassificationNodeView createNode(ClassificationNodeView nodeToBeCreated) throws WTException
      Create a node with the properties and attributes set in ClassificationNodeView

      Supported API: true
      Parameters:
      nodeToBeCreated -
      Returns:
      ClassificationNodeView of the created node
      Throws:
      WTException

    • updateNode

      public static ClassificationNodeView updateNode(ClassificationNodeView nodeToBeUpdated) throws WTException
      Update a node with the properties and attributes set in ClassificationNodeView

      Supported API: true
      Parameters:
      nodeToBeUpdated -
      Returns:
      ClassificationNodeView of the updated node
      Throws:
      WTException

    • getNode

      public static ClassificationNodeView getNode(String nodeName, String namespace) throws WTException
      Get a node view of the existing node

      Supported API: true
      Parameters:
      nodeName - - Internal name of the classification node
      namespaace - - Namespace to which the node belongs
      Returns:
      ClassificationNodeView of the node. Returns null if node could not be found
      Throws:
      WTException

    • deleteNode

      public static boolean deleteNode(String nodeName, String namespace) throws WTException
      Deletes an existing node

      Supported API: true
      Parameters:
      nodeName - - Internal name of the classification node
      namespace - - Namespace to which the node belongs
      Returns:
      Throws:
      WTException

    • isLeafNode

      public static boolean isLeafNode(String nodeName, String namespace) throws WTException
      Returns true if the classification node is a leaf node

      Supported API: true
      Parameters:
      nodeName - - Internal name of the classification node
      namespace - - Namespace to which the node belongs
      Returns:
      Throws:
      WTException

    • areObjectsClassifiedOnTheNode

      public static boolean areObjectsClassifiedOnTheNode(String nodeName, String namespace) throws WTException
      Returns true if there are any objects classified against the given clf node

      Supported API: true
      Parameters:
      nodeName - - Internal name of the classification node
      namespace - - Namespace to which the node belongs
      Returns:
      Throws:
      WTException

    • getAllNamespaces

      public static Set<String> getAllNamespaces() throws WTException
      This method returns a collection of all classification namespaces in the system

      Supported API: true
      Returns:
      A set of classification namespaces
      Throws:
      WTException

    • getAllRootNodesInNamespace

      public static List<ClassificationNodeView> getAllRootNodesInNamespace(String namespace) throws WTException
      This method returns all the classification root nodes in a given namespace

      Supported API: true
      Parameters:
      namespace -
      Returns:
      List of ClassificationNodeView of the root nodes
      Throws:
      WTException