wt.epm
Interface EPMDocumentManager

All Known Implementing Classes:

EPMDocumentManagerFwd, EPMStandardDocumentManager

public interface EPMDocumentManager

Supported API: true

Extendable: false

Method Summary

void	addToFamily(EPMDocument genericInst, EPMDocument instance, String asStoredName) Deprecated. at R8.0, use addToFamily( WTKeyedMap)
void	addToFamily(WTKeyedMap instances) Add a collection of instances to a given family by creating an EPMContainedIn link and an EPMVariantLink between the instance and the generic.
EPMDocumentMaster	changeCADName(EPMDocumentMaster master, String newCADName) Deprecated. use changeCADName(WTKeyedMap)
WTSet	changeCADName(WTKeyedMap masters) Changes the CAD name attributes on the given EPMDocumentMaster.
QueryResult	checkCompatibility(QueryResult documents) Deprecated. at R8.0, use checkCompatibility( WTCollection)
List	checkCompatibility(WTCollection documents) Verifies that the EPMDocuments passed as input are compatible.
QueryResult	checkoutFamilyTables(Collection instances, Collection familyTables, Folder workingFolder) Checkout the EPMDocuments representing family instances.
Vector	collectChangeCADNameVetos(EPMDocumentMaster target) Deprecated. no replacement
Vector	collectRenameVetos(WTObject object) Deprecated.
void	deleteObjects(Collection objects) Given a set of objects (Workables), deletes all the objects taking care of circular dependency between them.
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.
Boolean	isCADNameRequired(EPMAuthoringAppType type) Deprecated. This method always returns true because CAD name is required for all authoring application.
EPMDocument	makeStandalone(EPMDocument instance) Make a family instance a standalone document by removing the EPMContainedIn links and EPMVariantLinks.
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)
void	removeAllDependencies(WTCollection documents) Supported API: false
void	removeFromFamily(EPMDocument topLevelGeneric, EPMDocumentMaster instanceMaster) Deprecated. at R8.0, use removeFromfamily( EPMDocument, WTCollection)
void	removeFromFamily(EPMDocument generic, WTCollection instanceMasters) Removes a collection of family instance from a generic by removing the EPMContainedIn links between the instance and the generic.
QueryResult	reviseAll(Collection toRevise) Deprecated. at R8.0, use reviseALL( WTKeyedMap)
QueryResult	reviseAll(Collection toRevise, ReviseOptions options, ConfigSpec partConfigSpec) Deprecated. at R8.0, use reviseALL( WTKeyedMap)
WTKeyedMap	reviseAll(WTKeyedMap toRevise) This method creates a new in-line version of the EPMDocuments and WTParts given.
QueryResult	reviseDocsAndParts(EPMDocument[] docsToRevise, ReviseOptions options, ConfigSpec partConfigSpec) Deprecated. at R8.0, use reviseALL( WTKeyedMap)
QueryResult	reviseFamilyAndParts(EPMFamily family, ReviseOptions options, ConfigSpec partConfigSpec) Deprecated. at R8.0, use reviseALL( WTKeyedMap)
QueryResult	revisePartsAndDoc(EPMDocument docToRevise, ReviseOptions options, ConfigSpec partConfigSpec) Deprecated. Use reviseDocsAndParts(wt.epm.EPMDocument[], wt.epm.ReviseOptions, wt.vc.config.ConfigSpec)
QueryResult	revisePartsAndDoc(ObjectVector partsToRevise, ReviseOptions options) Deprecated. Get the build source document and then use reviseDocsAndParts(wt.epm.EPMDocument[], wt.epm.ReviseOptions, wt.vc.config.ConfigSpec) instead.
MultiDeleteValidationResult	validateObjectsForDeletion(Collection objects) Given a set of objects (Workables), validates the objects for deletion taking care of circular dependency between them.

Method Detail

removeAllDependencies

public void removeAllDependencies(EPMDocument document)
                           throws WTException

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

Supported API: true

Parameters:

document -

Throws:

WTException

checkCompatibility

public 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

public 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

revisePartsAndDoc

public QueryResult revisePartsAndDoc(EPMDocument docToRevise,
                                     ReviseOptions options,
                                     ConfigSpec partConfigSpec)
                              throws WTException

Deprecated. Use reviseDocsAndParts(wt.epm.EPMDocument[], wt.epm.ReviseOptions, wt.vc.config.ConfigSpec)

This method creates a new in-line version of the given EPMDocument as well as new in-line versions of all WTParts that the document builds. 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.

This method returns a QueryResult of object pairs. If the EPMDocument does not build any WTParts, this method will return an EPMDocument[2]. If it does, this method will return one EPMBuildRule[2] for each WTPart that the EPMDocument builds. The first element in the array contains the new version or build rule while the second contains the original version or build rule.

Use reviseFamilyAndParts(wt.epm.EPMFamily, wt.epm.ReviseOptions, wt.vc.config.ConfigSpec) if you need to revise all the members of the family together

Supported API: false

Parameters:

docToRevise - EPMDocument to revise

options - list of properties to assign to the newly created versions. If a property is not specified (i.e. set to null), the new version inherits the value for that property from the original version. The properties that you may specify are a folder and life cycle template for documents, a folder and life cycle template for parts and a project. If reviseParts property is set to false, only documents are revised else built parts are also revised.

partConfigSpec - configuration spec used to find the appropriate version of each WTPart that the given EPMDocument builds

Returns:

QueryResult

Throws:

WTException

See Also:

{@link #reviseFamilyAndParts}

removeAllDependencies

public void removeAllDependencies(WTCollection documents)
                           throws WTException

Supported API: false

Parameters:

documents -

Throws:

WTException

revisePartsAndDoc

public QueryResult revisePartsAndDoc(ObjectVector partsToRevise,
                                     ReviseOptions options)
                              throws WTException

Deprecated. Get the build source document and then use reviseDocsAndParts(wt.epm.EPMDocument[], wt.epm.ReviseOptions, wt.vc.config.ConfigSpec) instead.

This method creates new in-line versions of the given WTParts as well as a new in-line versions of EPMDocuments that build them. It copies the existing build rules from the original versions to the new versions. Such that, the new versions of the EPMDocuments build the new versions of the WTParts while the original versions continue to build the original versions.

This method returns a QueryResult of object pairs. For each WTPart that is not built by an EPMDocument, this method will return a WTPart[2]. For each WTPart that is built, this method will return an EPMBuildRule[2]. The first element in the array contains the new version or build rule while the second contains the original version or build rule.

This method does not attempt to revise family of objects together. If you need to revise all the members of family together, use reviseFamilyAndParts(wt.epm.EPMFamily, wt.epm.ReviseOptions, wt.vc.config.ConfigSpec) method.

Supported API: false

Parameters:

partsToRevise - list of the WTParts to revise

options - list of properties to assign to the newly created versions. If a property is not specified (i.e. set to null), the new version inherits the value for that property from the original version. The properties that you may specify are a folder and life cycle template for documents, a folder and life cycle template for parts and a project.

Returns:

QueryResult

Throws:

WTException

See Also:

reviseFamilyAndParts(wt.epm.EPMFamily, wt.epm.ReviseOptions, wt.vc.config.ConfigSpec), reviseDocsAndParts(wt.epm.EPMDocument[], wt.epm.ReviseOptions, wt.vc.config.ConfigSpec)

findReferencedIterations

public 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

public 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

collectRenameVetos

public Vector collectRenameVetos(WTObject object)
                          throws WTException

Deprecated.

Collect all the WTExceptions thrown by an attempt to Rename/number a given object. Return to client as a Vector. Deprecated. Use collectChangeCADNameVetos to collect the expcetion thrown when chaning CAD Name.

Supported API: false

Parameters:

object - The object which will be validated for rename/number.

Returns:

Vector

Throws:

WTException

changeCADName

public 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

collectChangeCADNameVetos

public Vector collectChangeCADNameVetos(EPMDocumentMaster target)
                                 throws WTException

Deprecated. no replacement

Collect all the WTExceptions thrown by an attempt to change CADName. Return to client as a Vector

Supported API: false

Parameters:

target -

Returns:

Vector

Throws:

WTException

isCADNameRequired

public Boolean isCADNameRequired(EPMAuthoringAppType type)
                          throws WTException

Deprecated. This method always returns true because CAD name is required for all authoring application.

Is CADName required for given AuthoringApplication type

Supported API: false

Parameters:

type - Authoring Application type

Returns:

Boolean

Throws:

WTException

markAsModified

public 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

removeFromFamily

public void removeFromFamily(EPMDocument topLevelGeneric,
                             EPMDocumentMaster instanceMaster)
                      throws WTException

Deprecated. at R8.0, use removeFromfamily( EPMDocument, WTCollection)

Removes a family instance from a generic by removing the EPMContainedIn links between the instance and the generic. Modify access to the generic is required.

Supported API: true

Parameters:

topLevelGeneric -

instanceMaster -

Throws:

WTException

reviseAll

public 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

addToFamily

public void addToFamily(EPMDocument genericInst,
                        EPMDocument instance,
                        String asStoredName)
                 throws WTException

Deprecated. at R8.0, use addToFamily( WTKeyedMap)

Add a family instance to a family by creating an EPMContainedIn link and an EPMVariantLink between the instance and the generic. If the generic specified is a nested generic, the EPMContainedIn link will be to the top level generic. Modify access to both the instance and the top level generic is required.

Supported API: true

Parameters:

genericInst -

instance -

asStoredName - Name of instance as stored in generic

Throws:

WTException

makeStandalone

public EPMDocument makeStandalone(EPMDocument instance)
                           throws WTException

Make a family instance a standalone document by removing the EPMContainedIn links and EPMVariantLinks. The instance may not be a generic. Modify access to the instance is required.

Supported API: true

Parameters:

instance -

Returns:

EPMDocument

Throws:

WTException

reviseDocsAndParts

public QueryResult reviseDocsAndParts(EPMDocument[] docsToRevise,
                                      ReviseOptions options,
                                      ConfigSpec partConfigSpec)
                               throws WTException

Deprecated. at R8.0, use reviseALL( WTKeyedMap)

This method creates a new in-line version of the given EPMDocuments as well as new in-line versions of all WTParts that the document builds. 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.

This method returns a QueryResult of object pairs. If the EPMDocument does not build any WTParts, this method will return an EPMDocument[2]. If it does, this method will return one EPMBuildRule[2] for each WTPart that the EPMDocument builds. The first element in the array contains the new version or build rule while the second contains the original version or build rule.

This method does not attempt to revise documents in a family together. Use reviseFamilyAndParts(wt.epm.EPMFamily, wt.epm.ReviseOptions, wt.vc.config.ConfigSpec) if you need to revise all the members of the family together.

Supported API: true

Parameters:

docsToRevise - Array of EPMDocuments to revise

options - list of properties to assign to the newly created versions. If a property is not specified (i.e. set to null), the new version inherits the value for that property from the original version. The properties that you may specify are a folder and life cycle template for documents, a folder and life cycle template for parts and a project. If reviseParts property is set to false, only documents are revised else built parts are also revised.

partConfigSpec - configuration spec used to find the appropriate version of each WTPart that the given EPMDocument builds

Returns:

QueryResult

Throws:

WTException

See Also:

{@link #reviseFamilyAndParts}

reviseFamilyAndParts

public QueryResult reviseFamilyAndParts(EPMFamily family,
                                        ReviseOptions options,
                                        ConfigSpec partConfigSpec)
                                 throws WTException

Deprecated. at R8.0, use reviseALL( WTKeyedMap)

This method creates a new in-line version of the all the member EPMDocuments of the given EPMFamily, as well as new in-line versions of all WTParts that these documents builds. 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.

EPMFamily should be complete (i.e. all the instances) should be added in family. Use EPMFamily.getEPMFamily(EPMDocument generic) to create/load EPMFamily.

This method returns a QueryResult of object pairs. If the EPMDocument does not build any WTParts, this method will return an EPMDocument[2]. If it does, this method will return one EPMBuildRule[2] for each WTPart that the EPMDocument builds. The first element in the array contains the new version or build rule while the second contains the original version or build rule.

Supported API: true

Parameters:

family - EPMFamily to be revised.

options - list of properties to assign to the newly created versions. If a property is not specified (i.e. set to null), the new version inherits the value for that property from the original version. The properties that you may specify are a folder and life cycle template for documents, a folder and life cycle template for parts and a project. If reviseParts property is set to false, only documents are revised else built parts are also revised.

partConfigSpec - configuration spec used to find the appropriate version of each WTPart that the given EPMDocument builds

Returns:

QueryResult

Throws:

WTException

checkCompatibility

public QueryResult checkCompatibility(QueryResult documents)
                               throws WTException

Deprecated. at R8.0, use checkCompatibility( WTCollection)

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

Supported API: false

Parameters:

documents - QueryResult of EPMDocuments to check

Returns:

QueryResult

Throws:

WTException

deleteObjects

public void deleteObjects(Collection objects)
                   throws WTException

Given a set of objects (Workables), deletes all the objects taking care of circular dependency between them.

Supported API: false

Parameters:

objects -

Throws:

WTException

validateObjectsForDeletion

public MultiDeleteValidationResult validateObjectsForDeletion(Collection objects)
                                                       throws WTException

Given a set of objects (Workables), validates the objects for deletion taking care of circular dependency between them. Returns null if all objects are valid else returns MultiDeleteValidateResult containing invalid objects.

Supported API: false

Parameters:

objects -

Returns:

MultiDeleteValidationResult

Throws:

WTException

reviseAll

public QueryResult reviseAll(Collection toRevise,
                             ReviseOptions options,
                             ConfigSpec partConfigSpec)
                      throws WTException

Deprecated. at R8.0, use reviseALL( WTKeyedMap)

This method creates a new in-line version of the given EPMDocuments and EPMFamilies as well as new in-line versions of all WTParts that the document builds. 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. In the case of an EPMFamily, the entire family is revised together, along with all associated WTParts. Instances and generics sent in as EPMDocuments shall be revised independently.

EPMFamily should be complete (i.e. all the instances) should be added in family. Use EPMFamily.getEPMFamily(EPMDocument generic) to create/load EPMFamily.

PLEASE NOTE that this API is temporary and will change.

This method returns a QueryResult of object pairs. If the EPMDocument does not build any WTParts, this method will return an EPMDocument[2]. If it does, this method will return one EPMBuildRule[2] for each WTPart that the EPMDocument builds. The first element in the array contains the new version or build rule while the second contains the original version or build rule.

Supported API: false

Parameters:

toRevise - Collection of EPMDocuments and EPMFamilies to revise. Any other objects specified in the array are ignored

options - list of properties to assign to the newly created versions. If a property is not specified (i.e. set to null), the new version inherits the value for that property from the original version. The properties that you may specify are a folder and life cycle template for documents, a folder and life cycle template for parts and a project. If reviseParts property is set to false, only documents are revised else built parts are also revised.

partConfigSpec - configuration spec used to find the appropriate version of each WTPart that the given EPMDocument builds

Returns:

QueryResult

Throws:

WTException

See Also:

{@link #reviseFamilyAndParts}, {@link #reviseDocsAndParts}

removeFromFamily

public void removeFromFamily(EPMDocument generic,
                             WTCollection instanceMasters)
                      throws WTException

Removes a collection of family instance from a generic by removing the EPMContainedIn links between the instance and the generic. Modify access to the generic is required.

Supported API: true

Parameters:

generic -

instanceMasters - Instance Masters to be removed

Throws:

WTException

reviseAll

public QueryResult reviseAll(Collection toRevise)
                      throws WTException

Deprecated. at R8.0, use reviseALL( WTKeyedMap)

This method creates a new in-line version of the EPMDocuments and WTParts given in the ReviseOptions. 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 QueryResult of object pairs. If the EPMDocument does not build any WTParts, this method will return an EPMDocument[2]. If it does, this method will return one EPMBuildRule[2] for each WTPart that the EPMDocument builds. The first element in the array contains the new version or build rule while the second contains the original version or build rule.

Supported API: false

Parameters:

toRevise - Collection of ReviseOptions which include the EPMDocuments andWTParts to revise in the object field of the ReviseOptions.

Returns:

QueryResult

Throws:

WTException

See Also:

{@link #reviseFamilyAndParts}, {@link #reviseDocsAndParts}

addToFamily

public void addToFamily(WTKeyedMap instances)
                 throws WTException

Add a collection of instances to a given family by creating an EPMContainedIn link and an EPMVariantLink between the instance and the generic. If the generic specified is a nested generic, the EPMContainedIn link will be to the top level generic. Modify access to both the instance and the top level generic is required.

Supported API: true

Parameters:

instances - A map with the EPMDocument instance as the key and A FamilyInfo object as the value. The FamilyInfo object will contain the immediate generic and other information such as the asStoredName.

Throws:

WTException

markAsModified

public 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

checkoutFamilyTables

public QueryResult checkoutFamilyTables(Collection instances,
                                        Collection familyTables,
                                        Folder workingFolder)
                                 throws WTException

Checkout the EPMDocuments representing family instances. Use the family table objects provided . The family table objects provided must be compatible with the instances.

Supported API: false

Parameters:

instances -

familyTables -

workingFolder - Folder in which to put the checked-out objects.

Returns:

QueryResult

Throws:

WTException

changeCADName

public 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