com.ptc.epm.commands.util
Class DocHelper

java.lang.Object
  com.ptc.epm.commands.util.DocHelper

public class DocHelper

extends Object

Nested Class Summary

static class

DocHelper.DocOptions

Field Summary

(package private) static WTContainerRef	_containerRef
static String	ECAD_WTCONTAINER_LIST
static String	ECAD_WTCONTAINER_VALUE
private static EPMDocument[]	EPM_DOCUMENT_ARRAY
private static List	pdmContainers
(package private) static boolean	SERVER

Constructor Summary

DocHelper()

Method Summary

static ECADDocument	createAsmDoc(ECADAssembly assembly, ECADDesign design, Folder folder, ECADTransaction transaction)
static ECADDocument	createBasicDoc(ECADDocument designDoc, Folder folder, ECADTransaction transaction)
static ECADDocument	createComponentDoc(String number, String name, String description, int quantity, ECADAssembly assembly, WTContainerRef containerRef, ECADTransaction transaction)
static ECADDocument	createContentDoc(String number, String name, ECADDocument ecadDoc, Folder folder, ECADTransaction transaction)
static ECADDocument	createDesignDoc(ECADDocument designDoc, ECADAssembly assembly, Folder folder, ECADTransaction transaction)
static EPMDocument	createDoc(EPMDocument epmDoc, DocHelper.DocOptions options, ECADTransaction transaction)
static EPMDocument	createDoc(String number, String name, DocHelper.DocOptions options, ECADTransaction transaction)
static EPMMemberLink	createMemberLink(ECADDocument parent, ECADDocument child, int quantity, ECADTransaction transaction)
static EPMReferenceLink	createReferenceLink(ECADDocument parent, ECADDocument child, ECADTransaction transaction)
static Vector	getCheckedOutItems(List objects)
static WTContainerRef	getContainerRef()
static EPMDocument[]	getDesignDocuments(Baseline baseline)
static EPMDocument[]	getDesignDocuments(EPMDocument document) Find all EPMDocuments in all ECADAssemblies which are part of the same ECADDesign as the input ECADAssembly (and are not checked out.
static QueryResult	getDocumentMastersByCADName(String name)
private static EPMDocumentType	getDocumentType(Object doc)
static String	getEPMDocumentType(EPMDocument epmDoc)
protected static List	getPDMLinkContainers()
protected static WhereExpression	getWhereSolutionIs(WTContainerRef containerRef)
static boolean	isAssemblyType(Object epmDoc)
static boolean	isBoardType(Object epmDoc)
static boolean	isComponentType(Object epmDoc)
static boolean	isContentType(Object epmDoc)
static boolean	isSchematicType(Object epmDoc)
static boolean	isSourceType(Object epmDoc)
static QueryResult	lookupDocument(String number, ConfigSpec configSpec)
static QueryResult	lookupDocuments(String[] numbers, ConfigSpec configSpec)
static void	setContainerRef(WTContainerRef myRef)

Methods inherited from class java.lang.Object

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

Field Detail

EPM_DOCUMENT_ARRAY

private static final EPMDocument[] EPM_DOCUMENT_ARRAY

ECAD_WTCONTAINER_VALUE

public static final String ECAD_WTCONTAINER_VALUE

See Also:

Constant Field Values

ECAD_WTCONTAINER_LIST

public static final String ECAD_WTCONTAINER_LIST

See Also:

Constant Field Values

SERVER

static final boolean SERVER

_containerRef

static WTContainerRef _containerRef

pdmContainers

private static List pdmContainers

Constructor Detail

DocHelper

public DocHelper()

Method Detail

setContainerRef

public static void setContainerRef(WTContainerRef myRef)
                            throws WTException

Throws:

WTException

getContainerRef

public static WTContainerRef getContainerRef()

getDocumentMastersByCADName

public static QueryResult getDocumentMastersByCADName(String name)
                                               throws WTException

Throws:

WTException

lookupDocument

public static QueryResult lookupDocument(String number,
                                         ConfigSpec configSpec)
                                  throws WTException

Throws:

WTException

lookupDocuments

public static QueryResult lookupDocuments(String[] numbers,
                                          ConfigSpec configSpec)
                                   throws WTException

Throws:

WTException

createContentDoc

public static ECADDocument createContentDoc(String number,
                                            String name,
                                            ECADDocument ecadDoc,
                                            Folder folder,
                                            ECADTransaction transaction)
                                     throws WTException,
                                            WTPropertyVetoException

Throws:

WTException

WTPropertyVetoException

createComponentDoc

public static ECADDocument createComponentDoc(String number,
                                              String name,
                                              String description,
                                              int quantity,
                                              ECADAssembly assembly,
                                              WTContainerRef containerRef,
                                              ECADTransaction transaction)
                                       throws WTException

Throws:

WTException

createAsmDoc

public static ECADDocument createAsmDoc(ECADAssembly assembly,
                                        ECADDesign design,
                                        Folder folder,
                                        ECADTransaction transaction)
                                 throws WTException,
                                        WTPropertyVetoException

Throws:

WTException

WTPropertyVetoException

createDesignDoc

public static ECADDocument createDesignDoc(ECADDocument designDoc,
                                           ECADAssembly assembly,
                                           Folder folder,
                                           ECADTransaction transaction)
                                    throws WTException,
                                           WTPropertyVetoException

Throws:

WTException

WTPropertyVetoException

createBasicDoc

public static ECADDocument createBasicDoc(ECADDocument designDoc,
                                          Folder folder,
                                          ECADTransaction transaction)
                                   throws WTException,
                                          WTPropertyVetoException

Throws:

WTException

WTPropertyVetoException

createDoc

public static EPMDocument createDoc(String number,
                                    String name,
                                    DocHelper.DocOptions options,
                                    ECADTransaction transaction)
                             throws WTException

Throws:

WTException

createDoc

public static EPMDocument createDoc(EPMDocument epmDoc,
                                    DocHelper.DocOptions options,
                                    ECADTransaction transaction)
                             throws WTException

Throws:

WTException

createReferenceLink

public static EPMReferenceLink createReferenceLink(ECADDocument parent,
                                                   ECADDocument child,
                                                   ECADTransaction transaction)
                                            throws WTException

Throws:

WTException

createMemberLink

public static EPMMemberLink createMemberLink(ECADDocument parent,
                                             ECADDocument child,
                                             int quantity,
                                             ECADTransaction transaction)
                                      throws WTException

Throws:

WTException

getDesignDocuments

public static EPMDocument[] getDesignDocuments(EPMDocument document)
                                        throws WTException

Find all EPMDocuments in all ECADAssemblies which are part of the same ECADDesign as the input ECADAssembly (and are not checked out.

Throws:

WTException

getDesignDocuments

public static EPMDocument[] getDesignDocuments(Baseline baseline)
                                        throws WTException

Throws:

WTException

getEPMDocumentType

public static String getEPMDocumentType(EPMDocument epmDoc)

getDocumentType

private static EPMDocumentType getDocumentType(Object doc)

isAssemblyType

public static boolean isAssemblyType(Object epmDoc)

isBoardType

public static boolean isBoardType(Object epmDoc)

isComponentType

public static boolean isComponentType(Object epmDoc)

isSchematicType

public static boolean isSchematicType(Object epmDoc)

isSourceType

public static boolean isSourceType(Object epmDoc)

isContentType

public static boolean isContentType(Object epmDoc)

getCheckedOutItems

public static Vector getCheckedOutItems(List objects)
                                 throws WTException

Throws:

WTException

getWhereSolutionIs

protected static WhereExpression getWhereSolutionIs(WTContainerRef containerRef)
                                             throws WTException

Throws:

WTException

getPDMLinkContainers

protected static List getPDMLinkContainers()
                                    throws WTException

Throws:

WTException