com.ptc.netmarkets.nmixb
Class DocTemplateCopyHelper

java.lang.Object
  wt.inf.template.containercopy.AbstractContainerCopyHandler
      com.ptc.netmarkets.nmixb.DocTemplateCopyHelper

All Implemented Interfaces:

ContainerCopyHandler, Serializable

public class DocTemplateCopyHelper

extends AbstractContainerCopyHandler

implements Serializable

This class copies PROJECT LEVEL document templates to the new project. Organization level document templates are already available to all projects in the system.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private static Object[]	DEF_PARAMS
private Map	docAclMap
private static int[]	FROM_INDICES
private static String	RESOURCE
private List	sourceProxies
private static TemplateInfo	ti
private CommonCopyWorklist	workList

Fields inherited from class wt.inf.template.containercopy.AbstractContainerCopyHandler

VERBOSE

Constructor Summary

DocTemplateCopyHelper()

Method Summary

protected void	copyAddedObjects() Most of the time this is the only method that needs to be over-ridden.
private WTDocument	copyDocAcls(ObjectIdentifier sourceOid, WTDocument newDoc)
static QueryResult	findDocTemplates(WTContainerRef contRef)
protected void	initialize() This method provides an opportunity to do any initializion beyond setting the three target member variables that is performed in at the start of the method.
void	postPostCopyFeedback() Posts post copy feedback.
void	postPreCopyFeedback() Posts pre-copy user feedback.
void	printPostCopyVerbose() Prints verbose post-copy statements.
void	printPreCopyVerbose() Prints verbose pre-copy statements.
protected void	pruneObjects() This is not necessary for every type of object, but there are times when it is most efficient to prune objects that are present in the target container, but are absent in the source container.
protected void	rememberSourceContainerObjects() Depending on the template being employed it may be necessary to to remember what was in the source container in order to do pruning.
private void	updateDocAclMap(WTDocument currDoc)

Methods inherited from class wt.inf.template.containercopy.AbstractContainerCopyHandler

copyObjects, getCopier, getSourceContainer, getTargetContainer, getWorklist, postFeedback, rememberTargetContainerObjects, setCopier, setSourceContainer, setTargetContainer, setWorklist

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

sourceProxies

private List sourceProxies

docAclMap

private Map docAclMap

DEF_PARAMS

private static Object[] DEF_PARAMS

workList

private CommonCopyWorklist workList

FROM_INDICES

private static final int[] FROM_INDICES

ti

private static final TemplateInfo ti

Constructor Detail

DocTemplateCopyHelper

public DocTemplateCopyHelper()

Method Detail

initialize

protected void initialize()
                   throws WTException

This method provides an opportunity to do any initializion beyond setting the three target member variables that is performed in at the start of the method.

Supported API: false

Overrides:

initialize in class AbstractContainerCopyHandler

Throws:

WTException

printPreCopyVerbose

public void printPreCopyVerbose()
                         throws WTException

Prints verbose pre-copy statements. Handler implementor is responsible for deciding what to use for this value. The handlers residing in wt.inf.template use the property wt.inf.template.verboseCopy

Supported API: false

Specified by:

printPreCopyVerbose in interface ContainerCopyHandler

Overrides:

printPreCopyVerbose in class AbstractContainerCopyHandler

Throws:

WTException

postPreCopyFeedback

public void postPreCopyFeedback()
                         throws WTException

Posts pre-copy user feedback.

Supported API: false

Specified by:

postPreCopyFeedback in interface ContainerCopyHandler

Overrides:

postPreCopyFeedback in class AbstractContainerCopyHandler

Throws:

WTException

rememberSourceContainerObjects

protected void rememberSourceContainerObjects()
                                       throws WTException

Depending on the template being employed it may be necessary to to remember what was in the source container in order to do pruning. This method is the hook that enables that to happen.

Supported API: false

Overrides:

rememberSourceContainerObjects in class AbstractContainerCopyHandler

Throws:

WTException

pruneObjects

protected void pruneObjects()
                     throws WTException

This is not necessary for every type of object, but there are times when it is most efficient to prune objects that are present in the target container, but are absent in the source container.

Supported API: false

Throws:

WTException

copyAddedObjects

protected void copyAddedObjects()
                         throws WTException

Most of the time this is the only method that needs to be over-ridden.

Supported API: false

Overrides:

copyAddedObjects in class AbstractContainerCopyHandler

Throws:

WTException

postPostCopyFeedback

public void postPostCopyFeedback()
                          throws WTException

Posts post copy feedback. (Copy of foo succeeded).

Supported API: false

Specified by:

postPostCopyFeedback in interface ContainerCopyHandler

Overrides:

postPostCopyFeedback in class AbstractContainerCopyHandler

Throws:

WTException

printPostCopyVerbose

public void printPostCopyVerbose()
                          throws WTException

Prints verbose post-copy statements. Handler implementor is responsible for deciding what to use for this value. The handlers residing in wt.inf.template use the property wt.inf.template.verboseCopy

Supported API: false

Specified by:

printPostCopyVerbose in interface ContainerCopyHandler

Overrides:

printPostCopyVerbose in class AbstractContainerCopyHandler

Throws:

WTException

updateDocAclMap

private void updateDocAclMap(WTDocument currDoc)
                      throws WTException

Throws:

WTException

copyDocAcls

private WTDocument copyDocAcls(ObjectIdentifier sourceOid,
                               WTDocument newDoc)
                        throws WTException

Throws:

WTException

findDocTemplates

public static QueryResult findDocTemplates(WTContainerRef contRef)
                                    throws WTException

Throws:

WTException