wt.epm
Interface EPMDocumentManager

public interface EPMDocumentManager

Supported API: true

Extendable: false

Method Summary

EPMDocumentMaster	changeCADName(EPMDocumentMaster master, String newCADName) Deprecated. use changeCADName(WTKeyedMap)
WTSet	changeCADName(WTKeyedMap masters) Changes the CAD name attributes on the given EPMDocumentMaster.
List	checkCompatibility(WTCollection documents) Verifies that the EPMDocuments passed as input are compatible.
QueryResult	findCheckedOutIterations(EPMDocumentMaster master) Deprecated. at R8.0, no replacement
QueryResult	findReferencedIterations(EPMDocumentMaster master) Deprecated. at R8.0, no replacement
QueryResult[]	getBomDifferences(EPMDocument firstDocument, EPMDocument secondDocument) Compares the bill of material of an EPMDocument with another EPMDocument.
void	markAsModified(QueryResult instances) Deprecated. at R8.0
void	markAsModified(WTCollection instances) Deprecated. at R8.0
void	removeAllDependencies(EPMDocument document) Deprecated. at R8.0, please use removeAllDependencies(WTCollection)
WTKeyedMap	reviseAll(WTKeyedMap toRevise) This method creates a new in-line version of the EPMDocuments and WTParts given.

Method Detail

removeAllDependencies

void removeAllDependencies(EPMDocument document)
                           throws WTException

Deprecated. at R8.0, please use removeAllDependencies(WTCollection)

Supported API: true

Parameters:

document -

Throws:

WTException

checkCompatibility

List checkCompatibility(WTCollection documents)
                        throws WTException

Verifies that the EPMDocuments passed as input are compatible. If there is no EPMDocument (generic) that holds all the input EPMDocuments (instances that are part of same family) then documents are considered as incompatible. It returns a List of EPMFamily objects for incompatible documents. Each EPMFamily object gives the information about incompatible instances.

Supported API: true

Parameters:

documents - Collection of EPMDocuments to check

Returns:

List

Throws:

WTException

getBomDifferences

QueryResult[] getBomDifferences(EPMDocument firstDocument,
                                EPMDocument secondDocument)
                                throws WTException

Compares the bill of material of an EPMDocument with another EPMDocument.

The element 0 of the returned array is a QueryResult that includes the EPMMemberLinks to identify the EPMDocumentMasters that were used in the first EPMDocument but not the second EPMDocument.

The element 1 of the returned array is a QueryResult that includes the EPMMemberLinks to identify the EPMDocumentMasters that were used in the second EPMDocument but not the first EPMDocument.

The element 2 of the returned array is a QueryResult that includes the EPMMemberLinks to identify the EPMDocumentMasters that were used in both the first and the second EPMDocuments but have different quantities.

Supported API: true

Parameters:

firstDocument -

secondDocument -

Returns:

QueryResult []

Throws:

WTException

findReferencedIterations

QueryResult findReferencedIterations(EPMDocumentMaster master)
                                     throws WTException

Deprecated. at R8.0, no replacement

Get the set of Iterations of the EPMDocumentMaster that are referenced by EPMWorkspaces.

Supported API: true

Parameters:

master -

Returns:

QueryResult

Throws:

WTException

findCheckedOutIterations

QueryResult findCheckedOutIterations(EPMDocumentMaster master)
                                     throws WTException

Deprecated. at R8.0, no replacement

Get the set of Iterations of the EPMDocumentMaster that are Checked Out.

Supported API: true

Parameters:

master -

Returns:

QueryResult

Throws:

WTException

changeCADName

EPMDocumentMaster changeCADName(EPMDocumentMaster master,
                                String newCADName)
                                throws WTException

Deprecated. use changeCADName(WTKeyedMap)

These method changes the CADl name attribute on the EPMDocumentMaster. This method fires EPMDocumentManagerChangeCADNameEvent. It also renames the content files of all the iterations to reflect the new CAD name.

Supported API: true

Parameters:

master -

newCADName - new CAD Name to be assigned

Returns:

EPMDocumentMaster

Throws:

WTException

markAsModified

void markAsModified(QueryResult instances)
                    throws WTException

Deprecated. at R8.0

Given a QueryResult of EPMDocuments representing family instances, set the geometryModified flag on the EPMContainedIn link between the family instance and the generic (container). The EPMContainedIn links from the instance to previous iterations of the generic will be removed. Modify access to both the instance and the generic is required.

Supported API: true

Parameters:

instances -

Throws:

WTException

reviseAll

WTKeyedMap reviseAll(WTKeyedMap toRevise)
                     throws WTException

This method creates a new in-line version of the EPMDocuments and WTParts given. It will match up the WTParts with the associated parts, and for those that are associated, it copies the existing build rules from the original versions to the new versions. Such that, the new version of the EPMDocument builds the new versions of the WTParts while the original version continues to build the original versions. If all instances along with the generic are passed in, the entire family is revised together, along with all associated WTParts. Instances and generics sent in without the complete family shall be revised independently.

This method returns a WTKeyedHashMap where the key is the original object and the value, the new version.

Supported API: true

Parameters:

toRevise - the key is the object to revise and the value a ReviseOptions object.

Returns:

WTKeyedMap

Throws:

WTException

markAsModified

void markAsModified(WTCollection instances)
                    throws WTException

Deprecated. at R8.0

Given a collection of EPMDocuments representing family instances, set the geometryModified flag on the EPMContainedIn link between the family instance and the generic (container). The EPMContainedIn links from the instance to previous iterations of the generic will be removed. Modify access to both the instance and the generic is required.

Supported API: true

Parameters:

instances - Collection of instances to be processed.

Throws:

WTException

changeCADName

WTSet changeCADName(WTKeyedMap masters)
                    throws WTException

Changes the CAD name attributes on the given EPMDocumentMaster. This method fires a EPMDocumentManagerEvent.PRE_CHANGE_CAD_NAME and POST_CHANGE_CAD_NAME event.

Supported API: true

Parameters:

masters - The keys are EPMDocumentMaster objects. The values are new CAD names.

Returns:

WTSet

Throws:

WTException