com.ptc.windchill.structconf
Class SamplePropagationAction

java.lang.Object
  com.ptc.windchill.structconf.PropagationAction
      com.ptc.windchill.structconf.SamplePropagationAction

public class SamplePropagationAction

extends PropagationAction

Nested Class Summary

private class

SamplePropagationAction.MyTextDerivedFile

Field Summary

private SamplePropagationAction.MyTextDerivedFile

aDerivedFile_

Constructor Summary

SamplePropagationAction()

Method Summary

void	evaluate(CollectedProperties collected_properties) Evaluate the custom action.
DerivedFile[]	getDerivedFiles() Return the set of DerivedFile objects that will be updated if this custom propagation action is evaluated.

Methods inherited from class com.ptc.windchill.structconf.PropagationAction

newPropagationActionException, newPropgationActionException

Methods inherited from class java.lang.Object

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

Field Detail

aDerivedFile_

private SamplePropagationAction.MyTextDerivedFile aDerivedFile_

Constructor Detail

SamplePropagationAction

public SamplePropagationAction()
                        throws PropagationActionException

Method Detail

getDerivedFiles

public DerivedFile[] getDerivedFiles()

Description copied from class: PropagationAction

Return the set of DerivedFile objects that will be updated if this custom propagation action is evaluated. Note that this method needs to function correctly before evaluation so that the StructConfManager can do timestamp- and file existence- based analysis of whether or not to perform propagation. If the knowledge of the product root is required to compute these files' paths, then the Paths API can be used. If kownledge about installed products/components/modules is required, you will have to wait another couple weeks for an install_tools API that will provide this information.

Specified by:

getDerivedFiles in class PropagationAction

evaluate

public void evaluate(CollectedProperties collected_properties)

Description copied from class: PropagationAction

Evaluate the custom action. The action will have access to the specified collected properties which can be used for whatever purpose the action wants.

A custom action should not ever write the derived file. Rather it should make changes in memory to the DerivedFile instances returned in getDerivedFiles. The StructConfManager will utilize the write methods on DerivedFile implementation to ensure that they get properly backed up and written in a safe way.

Specified by:

evaluate in class PropagationAction