Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

wt.epm
Class EPMStandardDocumentManager

java.lang.Object
  extended bywt.services.StandardManager
      extended bywt.epm.EPMStandardDocumentManager
All Implemented Interfaces:
EPMDocumentManager, Manager, NetFactor, Serializable
public class EPMStandardDocumentManager
extends StandardManager
implements EPMDocumentManager, Serializable

Use the newEPMStandardDocumentManager static factory method(s), not the EPMStandardDocumentManager constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: false

Extendable: false

See Also:
Serialized Form

Nested Class Summary
private  class EPMStandardDocumentManager.DeleteObjectInfo
           
private  class EPMStandardDocumentManager.LinkObjectInfo
           
 
Field Summary
private static String CLASSNAME
           
static String EPM_UNDO_CHECKOUT_CONTEXT_VALUE
           
private static String EPMRESOURCE
           
private static String RESOURCE
           
private static Comparator SERIES_COMPARATOR_FOR_DELETION
           
private static Comparator SERIES_COMPARATOR_FOR_INSTANCES
           
 
Fields inherited from class wt.services.StandardManager
 
Fields inherited from interface wt.services.Manager
MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE
 
Constructor Summary
EPMStandardDocumentManager()
           
 
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.
private  void dispatchVetoableEvent(String eventType, Object[] objects)
           
 QueryResult findCheckedOutIterations(EPMDocumentMaster master)
          Deprecated. at R8.0, no replacement
 QueryResult findReferencedIterations(EPMDocumentMaster master)
          Deprecated. at R8.0, no replacement
private  List getBaselinesContainingObjects(Collection objects)
           
 QueryResult[] getBomDifferences(EPMDocument firstDocument, EPMDocument secondDocument)
          Compares the bill of material of an EPMDocument with another EPMDocument.
 String getConceptualClassname()
          Deprecated.  
private  List getDocumentsWithAssociatedParts(Collection objects)
           
private  List getIntermediateIterations(EPMStandardDocumentManager.DeleteObjectInfo[] objectInfos, boolean reportIntermediates)
           
private  List getIntermediateVersions(EPMStandardDocumentManager.DeleteObjectInfo[] objectInfos)
           
private  Hashtable getMemberLinks(QueryResult memberLinks)
           
private  EPMStandardDocumentManager.DeleteObjectInfo[] getOrderedObjectInfos(Collection objects)
           
protected  void initialize()
          

Supported API: false
 Boolean isCADNameRequired(EPMAuthoringAppType type)
          Deprecated. This method always returns true because CAD name is required for all authoring application.
private  boolean isSelectedForDeletion(long[] objectIDs, long id)
           
 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
static EPMStandardDocumentManager newEPMStandardDocumentManager()
          Default factory for the class.
private  QuerySpec oldModelContainedInLinkFilter()
           
protected  void performStartupProcess()
          Overrides the startup process specific to the locking service to provide custom startup for event subscription.
private  void processCADNamePostStoreEvent(WTCollection masters)
           
private  void processEPMDocPostStoreEvent(WTCollection docs)
           
private  void processPostChangeFolderEvent(FolderServiceEvent pmEvent, EPMDocument document)
           
private  void processPostDeleteEvent(EPMSepFamilyTable familyTable)
           
private  void processPostDeleteFTEvent(WTCollection familyTables)
          method removes orphaned EPMFamilyTableMasters
private  void processPreAddBaselineEvent(SandboxBaseline baseline, WTCollection documents)
           
private  void processPreDeleteEvent(ManagedBaseline baseline)
           
private  void processPreReplaceBaselineEvent(SandboxBaseline baseline, WTCollection documents)
           
private  void processPreSBCheckout(WTValuedMap originalToWorkingCopyMap)
           
private  void processRemoveShareEvent(Collection sharedContainerMaps)
          Responds to remove share event emitted by DataSharingService and cleans CADNamespace
 void registerEvents(ManagerService manager)
          Overrides the registration of all applicable locking service events with the service manager.
 void removeAllDependencies(EPMDocument document)
          Deprecated. at R8.0, please use removeAllDependencies(WTCollection)
 void removeAllDependencies(WTCollection documents)
          

Supported API: false
private  void removeAllDependencyLinks(EPMDocument document, String role, Class linkClass)
           
 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.
private  QueryResult revisePartsAndDocs(ObjectVector partsToRevise, ReviseOptions options)
          This method creates new in-line versions of the given WTParts as well as a new in-line versions of EPMDocuments that build them.
private  QueryResult sortInstances(QueryResult containedInLinks, EPMDocument container)
           
private  QueryResult sortInstances(QueryResult containedInLinks, EPMDocument container, boolean reverseOrder)
           
 MultiDeleteValidationResult validateObjectsForDeletion(Collection objects)
          Given a set of objects (Workables), validates the objects for deletion taking care of circular dependency between them.
private  void validateSharing(Collection sharedContainerMaps)
          Check whether it is valid sharing or not.
private  List verifyFamilyObjects(Collection objects, MultiDeleteValidationResult validationResult)
          Verifies that instances for all iterations of given version of generics exists in the list of objects passed.
private  void vetoAuthoringAppVersionChanges()
           
 
Methods inherited from class wt.services.StandardManager
emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

RESOURCE

private static final String RESOURCE
See Also:
Constant Field Values

CLASSNAME

private static final String CLASSNAME

EPMRESOURCE

private static final String EPMRESOURCE
See Also:
Constant Field Values

EPM_UNDO_CHECKOUT_CONTEXT_VALUE

public static final String EPM_UNDO_CHECKOUT_CONTEXT_VALUE
See Also:
Constant Field Values

SERIES_COMPARATOR_FOR_DELETION

private static final Comparator SERIES_COMPARATOR_FOR_DELETION

SERIES_COMPARATOR_FOR_INSTANCES

private static final Comparator SERIES_COMPARATOR_FOR_INSTANCES
Constructor Detail

EPMStandardDocumentManager

public EPMStandardDocumentManager()
Method Detail

getConceptualClassname

public String getConceptualClassname()
Deprecated.  

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:
getConceptualClassname in interface NetFactor
Overrides:
getConceptualClassname in class StandardManager
Returns:
String

initialize

protected void initialize()
                   throws WTException


Supported API: false

Overrides:
initialize in class StandardManager
Throws:
WTException

performStartupProcess

protected void performStartupProcess()
                              throws ManagerException
Overrides the startup process specific to the locking service to provide custom startup for event subscription. During subscription an anonymous inner class adapter is created per subscription to handle each specific event of interest.

Supported API: false

Overrides:
performStartupProcess in class StandardManager
Throws:
ManagerException

registerEvents

public void registerEvents(ManagerService manager)
Overrides the registration of all applicable locking service events with the service manager.

Supported API: false

Specified by:
registerEvents in interface Manager
Overrides:
registerEvents in class StandardManager
Parameters:
manager -

newEPMStandardDocumentManager

public static EPMStandardDocumentManager newEPMStandardDocumentManager()
                                                                throws WTException
Default factory for the class.

Supported API: false

Returns:
EPMStandardDocumentManager
Throws:
WTException

removeAllDependencies

public void removeAllDependencies(EPMDocument document)
                           throws WTException
Deprecated. at R8.0, please use removeAllDependencies(WTCollection)



Supported API: false

Specified by:
removeAllDependencies in interface EPMDocumentManager
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: false

Specified by:
checkCompatibility in interface EPMDocumentManager
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: false

Specified by:
getBomDifferences in interface EPMDocumentManager
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

Specified by:
revisePartsAndDoc in interface EPMDocumentManager
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

Specified by:
removeAllDependencies in interface EPMDocumentManager
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

Specified by:
revisePartsAndDoc in interface EPMDocumentManager
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: false

Specified by:
findReferencedIterations in interface EPMDocumentManager
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: false

Specified by:
findCheckedOutIterations in interface EPMDocumentManager
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

Specified by:
collectRenameVetos in interface EPMDocumentManager
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: false

Specified by:
changeCADName in interface EPMDocumentManager
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

Specified by:
collectChangeCADNameVetos in interface EPMDocumentManager
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

Specified by:
isCADNameRequired in interface EPMDocumentManager
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: false

Specified by:
markAsModified in interface EPMDocumentManager
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: false

Specified by:
removeFromFamily in interface EPMDocumentManager
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: false

Specified by:
reviseAll in interface EPMDocumentManager
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: false

Specified by:
addToFamily in interface EPMDocumentManager
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: false

Specified by:
makeStandalone in interface EPMDocumentManager
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: false

Specified by:
reviseDocsAndParts in interface EPMDocumentManager
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: false

Specified by:
reviseFamilyAndParts in interface EPMDocumentManager
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

Specified by:
checkCompatibility in interface EPMDocumentManager
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

Specified by:
deleteObjects in interface EPMDocumentManager
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

Specified by:
validateObjectsForDeletion in interface EPMDocumentManager
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

Specified by:
reviseAll in interface EPMDocumentManager
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: false

Specified by:
removeFromFamily in interface EPMDocumentManager
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

Specified by:
reviseAll in interface EPMDocumentManager
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: false

Specified by:
addToFamily in interface EPMDocumentManager
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: false

Specified by:
markAsModified in interface EPMDocumentManager
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

Specified by:
checkoutFamilyTables in interface EPMDocumentManager
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: false

Specified by:
changeCADName in interface EPMDocumentManager
Parameters:
masters - The keys are EPMDocumentMaster objects. The values are new CAD names.
Returns:
WTSet
Throws:
WTException

removeAllDependencyLinks

private void removeAllDependencyLinks(EPMDocument document,
                                      String role,
                                      Class linkClass)
                               throws WTException
Throws:
WTException

processPreDeleteEvent

private void processPreDeleteEvent(ManagedBaseline baseline)
                            throws WTException
Throws:
WTException

processCADNamePostStoreEvent

private void processCADNamePostStoreEvent(WTCollection masters)
                                   throws WTException
Throws:
WTException

processEPMDocPostStoreEvent

private void processEPMDocPostStoreEvent(WTCollection docs)
                                  throws WTException
Throws:
WTException

processPostDeleteFTEvent

private void processPostDeleteFTEvent(WTCollection familyTables)
                               throws WTException
method removes orphaned EPMFamilyTableMasters

Parameters:
familyTables - WTColletion Family Tables that where deleted in current trunsaction
Throws:
WTException

processPostDeleteEvent

private void processPostDeleteEvent(EPMSepFamilyTable familyTable)
                             throws WTException
Throws:
WTException

oldModelContainedInLinkFilter

private QuerySpec oldModelContainedInLinkFilter()
                                         throws WTException
Throws:
WTException

sortInstances

private QueryResult sortInstances(QueryResult containedInLinks,
                                  EPMDocument container)
                           throws WTException
Throws:
WTException

sortInstances

private QueryResult sortInstances(QueryResult containedInLinks,
                                  EPMDocument container,
                                  boolean reverseOrder)
                           throws WTException
Throws:
WTException

getMemberLinks

private Hashtable getMemberLinks(QueryResult memberLinks)
                          throws WTException
Throws:
WTException

revisePartsAndDocs

private QueryResult revisePartsAndDocs(ObjectVector partsToRevise,
                                       ReviseOptions options)
                                throws WTException
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

processPostChangeFolderEvent

private void processPostChangeFolderEvent(FolderServiceEvent pmEvent,
                                          EPMDocument document)
                                   throws WTException
Throws:
WTException

dispatchVetoableEvent

private void dispatchVetoableEvent(String eventType,
                                   Object[] objects)
                            throws WTException,
                                   WTPropertyVetoException
Throws:
WTException
WTPropertyVetoException

getOrderedObjectInfos

private EPMStandardDocumentManager.DeleteObjectInfo[] getOrderedObjectInfos(Collection objects)
                                                                     throws WTException
Throws:
WTException

getBaselinesContainingObjects

private List getBaselinesContainingObjects(Collection objects)
                                    throws WTException
Throws:
WTException

verifyFamilyObjects

private List verifyFamilyObjects(Collection objects,
                                 MultiDeleteValidationResult validationResult)
                          throws WTException
Verifies that instances for all iterations of given version of generics exists in the list of objects passed. Also verifies that generics for all iterations of given version of instances exists in the list of objects passed. If any generic / instance is missing then it throws exception if validationResult is null, Else it collects all missing generics and instances and add them to validationResult. Returns vector of instances present in list of objects passed (whose generics are also present in the list).

Throws:
WTException

getIntermediateIterations

private List getIntermediateIterations(EPMStandardDocumentManager.DeleteObjectInfo[] objectInfos,
                                       boolean reportIntermediates)
                                throws WTException
Throws:
WTException

isSelectedForDeletion

private boolean isSelectedForDeletion(long[] objectIDs,
                                      long id)

getIntermediateVersions

private List getIntermediateVersions(EPMStandardDocumentManager.DeleteObjectInfo[] objectInfos)
                              throws WTException
Throws:
WTException

getDocumentsWithAssociatedParts

private List getDocumentsWithAssociatedParts(Collection objects)
                                      throws WTException
Throws:
WTException

processRemoveShareEvent

private void processRemoveShareEvent(Collection sharedContainerMaps)
                              throws WTException,
                                     WTPropertyVetoException
Responds to remove share event emitted by DataSharingService and cleans CADNamespace

Parameters:
sharedContainerMaps - collection of SharedContainerMap
Throws:
WTException
WTPropertyVetoException

validateSharing

private void validateSharing(Collection sharedContainerMaps)
                      throws WTException
Check whether it is valid sharing or not.

Parameters:
sharedContainerMaps - collection of SharedContainerMap
Throws:
WTException

processPreAddBaselineEvent

private void processPreAddBaselineEvent(SandboxBaseline baseline,
                                        WTCollection documents)
                                 throws WTException
Throws:
WTException

processPreReplaceBaselineEvent

private void processPreReplaceBaselineEvent(SandboxBaseline baseline,
                                            WTCollection documents)
                                     throws WTException
Throws:
WTException

processPreSBCheckout

private void processPreSBCheckout(WTValuedMap originalToWorkingCopyMap)
                           throws WTException
Throws:
WTException

vetoAuthoringAppVersionChanges

private void vetoAuthoringAppVersionChanges()
                                     throws WTException
Throws:
WTException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD