com.ptc.windchill.cadx.common.util
Class ContainerQueryUtilities

java.lang.Object
  extended bycom.ptc.windchill.cadx.common.util.ContainerQueryUtilities

public class ContainerQueryUtilities
extends Object


Field Summary
private static Class[] PDMLinkContainerClasses
           
static List PDMLinkContainerClassList
           
private static Class[] ProjectLinkContainerClasses
           
static List ProjectLinkContainerClassList
           
private static boolean VERBOSE
           
 
Constructor Summary
ContainerQueryUtilities()
           
 
Method Summary
static QueryResult getAllContainers(boolean filterByMembership)
          Get all the containers of to which user has access.
static QueryResult getClassicContainers()
          Find out all classic solution based containers.
private static QueryResult getContainers(Class containerClass, boolean filterByMembership, boolean includeClassic, boolean includeContainersThatUserIsAdminOf)
           
private static QueryResult getContainers(Collection containerClasses, boolean filterByMembership, boolean includeClassic, boolean includeContainersThatUserIsAdminOf)
           
private static QueryResult getContainers(Collection containerClasses, Collection contRefs, boolean filterByMembership, boolean includeClassic, boolean includeContainersThatUserIsAdminOf)
           
static Vector getContainersForSolution(WTContainer container)
          Gets the containers specific for one solution.
static QueryResult getPDMLinkContainers()
          Find out all PDMLink solution based containers.
static QueryResult getPDMLinkContainers(Collection contRefs)
           
static QueryResult getPDMLinkLibraries()
           
static QueryResult getPDMLinkProducts()
           
static QueryResult getProjectLinkContainers()
          Find out all ProjectLink solution based containers.
static String getWindchillPDMContainerOid()
          Get WIndchill PDM container oid in the string form.
static WTContainer getWTContainerByName(String containerName)
          Deprecated. Does not work correctly when duplicate container names are found. Use getWTContainerByName(String containerName, WTContainer contextContainer) instead.
static WTContainer getWTContainerByName(String containerName, WTContainer contextContainer)
          For the specified container name, find out the container object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

VERBOSE

private static boolean VERBOSE

PDMLinkContainerClasses

private static final Class[] PDMLinkContainerClasses

PDMLinkContainerClassList

public static final List PDMLinkContainerClassList

ProjectLinkContainerClasses

private static final Class[] ProjectLinkContainerClasses

ProjectLinkContainerClassList

public static final List ProjectLinkContainerClassList
Constructor Detail

ContainerQueryUtilities

public ContainerQueryUtilities()
Method Detail

getAllContainers

public static QueryResult getAllContainers(boolean filterByMembership)
                                    throws WTException,
                                           WTPropertyVetoException
Get all the containers of to which user has access. If filterByMembership is true, then return only those containers where user has membership.

Throws:
WTException
WTPropertyVetoException

getPDMLinkContainers

public static QueryResult getPDMLinkContainers()
                                        throws WTException,
                                               QueryException
Find out all PDMLink solution based containers. PDMlink solution has more than one type (Class) of containers. Find out containers for all such classes of containers.

Throws:
WTException
QueryException

getPDMLinkContainers

public static QueryResult getPDMLinkContainers(Collection contRefs)
                                        throws WTException,
                                               QueryException
Throws:
WTException
QueryException

getPDMLinkProducts

public static QueryResult getPDMLinkProducts()
                                      throws WTException,
                                             WTPropertyVetoException
Throws:
WTException
WTPropertyVetoException

getPDMLinkLibraries

public static QueryResult getPDMLinkLibraries()
                                       throws WTException,
                                              WTPropertyVetoException
Throws:
WTException
WTPropertyVetoException

getProjectLinkContainers

public static QueryResult getProjectLinkContainers()
                                            throws WTException,
                                                   QueryException
Find out all ProjectLink solution based containers.

Throws:
WTException
QueryException

getClassicContainers

public static QueryResult getClassicContainers()
                                        throws WTException,
                                               QueryException
Find out all classic solution based containers.

Throws:
WTException
QueryException

getContainersForSolution

public static Vector getContainersForSolution(WTContainer container)
                                       throws WTException
Gets the containers specific for one solution.

Throws:
WTException

getContainers

private static QueryResult getContainers(Class containerClass,
                                         boolean filterByMembership,
                                         boolean includeClassic,
                                         boolean includeContainersThatUserIsAdminOf)
                                  throws WTException,
                                         QueryException
Throws:
WTException
QueryException

getContainers

private static QueryResult getContainers(Collection containerClasses,
                                         boolean filterByMembership,
                                         boolean includeClassic,
                                         boolean includeContainersThatUserIsAdminOf)
                                  throws WTException,
                                         QueryException
Throws:
WTException
QueryException

getContainers

private static QueryResult getContainers(Collection containerClasses,
                                         Collection contRefs,
                                         boolean filterByMembership,
                                         boolean includeClassic,
                                         boolean includeContainersThatUserIsAdminOf)
                                  throws WTException,
                                         QueryException
Throws:
WTException
QueryException

getWTContainerByName

public static WTContainer getWTContainerByName(String containerName)
                                        throws WTException
Deprecated. Does not work correctly when duplicate container names are found. Use getWTContainerByName(String containerName, WTContainer contextContainer) instead.

For the specified container name, return back the WTContainer object.

Throws:
WTException

getWTContainerByName

public static WTContainer getWTContainerByName(String containerName,
                                               WTContainer contextContainer)
                                        throws WTException
For the specified container name, find out the container object. Focus on the containers which belong to same solution context as that of the specified context container.

Throws:
WTException

getWindchillPDMContainerOid

public static String getWindchillPDMContainerOid()
Get WIndchill PDM container oid in the string form. If Windchill PDM is not installed or if user does not have access to it, null will be returned.