com.ptc.windchill.enterprise.templates
Interface TemplatesContextDelegate

All Known Implementing Classes:

TemplatesEnterpriseWTDocumentDelegate

public interface TemplatesContextDelegate

Delegate for the UI to process templates. The appropriate function is picked by the factory based on the solution and the object type within the solution. For ex:- If WTDocument specific tasks have to be performed for PDMLink. The appropriate WTDocument method will be picked within the PDMLink solution, when a delegate class implementing this interface is defined. The delegate class could be TemplatesPDMLinkWTDocumentDelegate in com.ptc.winchill.pdmlink.templates.doc.server package. If foundation tasks have to be performed irrespective of the object type, the appropriate method will be picked, when a delegate class implementing this interface is defined. The delegate class could be TemplatesEnterpriseDelegate in com.ptc.windchill.enterprise.templates package

Supported API: true

Extendable: false

Method Summary

RevisionControlled	doCreateFromTemplateContextTasks(RevisionControlled object, Templateable template, HashMap inputHash) Perform context specific tasks during Create from Template operation.
Templateable	doCreateTemplateContextTasks(Templateable object, HashMap inputHash) Perform context specific tasks during Create Template operation.
RevisionControlled	doPostCreateFromTemplateContextTasks(RevisionControlled object, Templateable template, HashMap inputHash) Perform context specific tasks after persisting the object created from template during a Create from Template operation.
Templateable	doPostCreateTemplateContextTasks(Templateable object, HashMap inputHash) Perform context specific tasks after persisting the template during a Create Template operation.

Method Detail

doCreateTemplateContextTasks

public Templateable doCreateTemplateContextTasks(Templateable object,
                                                 HashMap inputHash)
                                          throws WTException

Perform context specific tasks during Create Template operation. The context could be just the solution irrespective of the object or it could be for a particular object type within a solution.

Supported API: true

Parameters:

object - Template object to perform context based createtemplate tasks on.

inputHash - A hashmap of custom values that need to be passed into the method.

Returns:

Templateable

Throws:

WTException

doCreateFromTemplateContextTasks

public RevisionControlled doCreateFromTemplateContextTasks(RevisionControlled object,
                                                           Templateable template,
                                                           HashMap inputHash)
                                                    throws WTException

Perform context specific tasks during Create from Template operation. The context could be just the solution irrespective of the object or it could be for a particular object type within a solution.

Supported API: true

Parameters:

object - Object created from template to perform context based createfromtemplate tasks on.

template - template that the object was create from during createfromtemplate

inputHash - A hashmap of custom values that need to be passed into the method.

Returns:

RevisionControlled

Throws:

WTException

doPostCreateTemplateContextTasks

public Templateable doPostCreateTemplateContextTasks(Templateable object,
                                                     HashMap inputHash)
                                              throws WTException

Perform context specific tasks after persisting the template during a Create Template operation. The context could be just the solution irrespective of the object or it could be for a particular object type within a solution.

Supported API: true

Parameters:

object - Template object to perform context based post createtemplate tasks on.

inputHash - A hashmap of custom values that need to be passed into the method.

Returns:

Templateable

Throws:

WTException

doPostCreateFromTemplateContextTasks

public RevisionControlled doPostCreateFromTemplateContextTasks(RevisionControlled object,
                                                               Templateable template,
                                                               HashMap inputHash)
                                                        throws WTException

Perform context specific tasks after persisting the object created from template during a Create from Template operation. The context could be just the solution irrespective of the object or it could be for a particular object type within a solution.

Supported API: true

Parameters:

object - Object created from template to perform context based post createfromtemplate tasks on.

template - template that the object was create from during createfromtemplate

inputHash - A hashmap of custom values that need to be passed into the method.

Returns:

RevisionControlled

Throws:

WTException