com.ptc.hli.ecad
Class ECADQueryHelper

java.lang.Object
  com.ptc.hli.ecad.ECADQueryHelper

public class ECADQueryHelper

extends Object

This is a helper class which provides set of static methods for query. This class provides methods to get existing team template names, views, cabinets and lifecycles. This class, also, provides methods to get documents given a criteria.

Supported API: true

Extendable: false

Nested Class Summary

protected static class

ECADQueryHelper.ECADQueryServer

Field Summary

(package private) static boolean	SERVER
private static String	SERVER_CLASS

Constructor Summary

ECADQueryHelper()

Method Summary

static List	findComponentList(String docNumber, String version, String solution, String context) Gets the Components used by a given Assembly of a design Supported API: true
static String	findPrimaryAssembly(String docNumber, String version, String solution, String context) Gets the Assembly which has been assigned as the Primary Assembly of a design Supported API: true
static Collection	getAssemblyDocs(Properties attributes) Gets the ECAD Documents with specified attributes.
static Collection	getAssemblyDocs(String authoringApp, int numberDays, int numberToReturn, boolean notCheckedOut, WTContainerRef containerRef) Gets the ECAD Assembly documents that the current user worked on within the last "numberDays" days.
static Vector	getCabinetNames(WTContainerRef containerRef) Gets the cabinet names.
static Vector	getCabinets(WTContainerRef containerRef) Gets the cabinets for the given container. Supported API: true
static Vector	getLifeCycle(Class inputClass) Gets the life cycle names.
static Vector	getLifeCycle(Class inputClass, WTContainerRef containerRef)
static PDMLinkProduct	getProduct(String name)
static Vector	getProductNames()
static Project2	getProject(String name)
static Vector	getProjects() Gets the project names.
static Vector	getTeamTemplates(WTContainerRef containerRef) Gets the names of all team templates.
static Vector	getViews() Gets the view names.
static boolean	isWindchillPDMInstalled()
static boolean	isWindchillPDMLinkInstalled()
static boolean	isWindchillProjectLinkInstalled()
static WTContainerTemplate	lookupProductTemplate(OrgContainer org, String productTemplateName)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERVER_CLASS

private static final String SERVER_CLASS

SERVER

static final boolean SERVER

Constructor Detail

ECADQueryHelper

public ECADQueryHelper()

Method Detail

getProjects

public static Vector getProjects()
                          throws WTException

Gets the project names.

Supported API: true

Returns:

A Vector of String. The names of projects.

Throws:

WTException

getTeamTemplates

public static Vector getTeamTemplates(WTContainerRef containerRef)
                               throws WTException

Gets the names of all team templates.

Supported API: false

Returns:

A Vector of String. The names of all team templates.

Throws:

WTException

getViews

public static Vector getViews()
                       throws WTException

Gets the view names.

Supported API: true

Returns:

A Vector of String. The names of views.

Throws:

WTException

getLifeCycle

public static Vector getLifeCycle(Class inputClass)
                           throws WTException

Gets the life cycle names.

Supported API: true

Returns:

A Vector of String. The names of life cycle.

Throws:

WTException

getLifeCycle

public static Vector getLifeCycle(Class inputClass,
                                  WTContainerRef containerRef)
                           throws WTException

Throws:

WTException

getCabinetNames

public static Vector getCabinetNames(WTContainerRef containerRef)
                              throws WTException

Gets the cabinet names.

Supported API: true

Returns:

A Vector of String. The names of cabinets.

Throws:

WTException

getCabinets

public static Vector getCabinets(WTContainerRef containerRef)
                          throws WTException

Gets the cabinets for the given container.


Supported API: true

Returns:

A Vector of String. The names of cabinets.

Throws:

WTException

getAssemblyDocs

public static Collection getAssemblyDocs(Properties attributes)
                                  throws WTException

Gets the ECAD Documents with specified attributes.

Supported API: true

Returns:

Collection A Collection of ECAD Document vectors. The first element is the Source Doc for all that follow

Throws:

WTException

See Also:

com.ptc.hli.cad.ECADDocument

getAssemblyDocs

public static Collection getAssemblyDocs(String authoringApp,
                                         int numberDays,
                                         int numberToReturn,
                                         boolean notCheckedOut,
                                         WTContainerRef containerRef)
                                  throws WTException

Gets the ECAD Assembly documents that the current user worked on within the last "numberDays" days. The number of documents not to exceed "numberToReturn".

Supported API: true

Returns:

Collection A Collection of ECAD Document vectors. The first element is the Source Doc for all that follow

Throws:

WTException

See Also:

com.ptc.hli.cad.ECADDocument

findPrimaryAssembly

public static String findPrimaryAssembly(String docNumber,
                                         String version,
                                         String solution,
                                         String context)
                                  throws WTException

Gets the Assembly which has been assigned as the Primary Assembly of a design

Supported API: true

Returns:

String The identifying number of the Primary assembly String of length 0 if none found

Throws:

WTException

findComponentList

public static List findComponentList(String docNumber,
                                     String version,
                                     String solution,
                                     String context)
                              throws WTException

Gets the Components used by a given Assembly of a design

Supported API: true

Returns:

List The identifying numbers of the components of the assembly String of length 0 if none found

Throws:

WTException

getProductNames

public static Vector getProductNames()
                              throws WTException

Throws:

WTException

getProduct

public static PDMLinkProduct getProduct(String name)
                                 throws WTException

Throws:

WTException

getProject

public static Project2 getProject(String name)
                           throws WTException

Throws:

WTException

lookupProductTemplate

public static WTContainerTemplate lookupProductTemplate(OrgContainer org,
                                                        String productTemplateName)
                                                 throws WTException

Throws:

WTException

isWindchillPDMLinkInstalled

public static boolean isWindchillPDMLinkInstalled()

isWindchillPDMInstalled

public static boolean isWindchillPDMInstalled()

isWindchillProjectLinkInstalled

public static boolean isWindchillProjectLinkInstalled()