com.ptc.epm.commands
Class ECADNewRevision.RevisionServer

java.lang.Object
  com.ptc.epm.commands.ECADNewRevision.RevisionServer

All Implemented Interfaces:

RemoteAccess

Enclosing class:

ECADNewRevision

protected static class ECADNewRevision.RevisionServer

extends Object

implements RemoteAccess

Field Summary

(package private) static String

EPM_MULTI_REVISE_IN_PROGRESS

Fields inherited from interface wt.method.RemoteAccess

versionID

Constructor Summary

protected

ECADNewRevision.RevisionServer()

Method Summary

static WTKeyedMap	reviseAll(Collection toRevise, ReviseOptions options, EPMAsStoredConfig storedConfig, ConfigSpec partConfigSpec) 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.
static String	reviseDesignDocuments(Vector documentsToRevise, EPMAsStoredConfig storedConfig)
private static void	setEPMMultiReviseInProgress(boolean inProgress)

Methods inherited from class java.lang.Object

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

Field Detail

EPM_MULTI_REVISE_IN_PROGRESS

static final String EPM_MULTI_REVISE_IN_PROGRESS

See Also:

Constant Field Values

Constructor Detail

ECADNewRevision.RevisionServer

protected ECADNewRevision.RevisionServer()

Method Detail

reviseDesignDocuments

public static String reviseDesignDocuments(Vector documentsToRevise,
                                           EPMAsStoredConfig storedConfig)
                                    throws WTException

Throws:

WTException

reviseAll

public static WTKeyedMap reviseAll(Collection toRevise,
                                   ReviseOptions options,
                                   EPMAsStoredConfig storedConfig,
                                   ConfigSpec partConfigSpec)
                            throws WTException,
                                   WTPropertyVetoException

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.

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.

Parameters:

toRevise - Collection of EPMDocuments and EPMFamilies 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

WTPropertyVetoException

setEPMMultiReviseInProgress

private static void setEPMMultiReviseInProgress(boolean inProgress)