com.ptc.windchill.enterprise.copy.server
Interface TemplateObjectDelegate

All Known Implementing Classes:

WTDocumentTemplateDelegate

public interface TemplateObjectDelegate

Delegate for the UI to process documents with. Allows customers to substitute site specific processing.

Supported API: true

Extendable: true

Method Summary

Templateable	createFromTemplate(Templateable objTemplate, HashMap nameValueData, Locale locale, String applicationName) Deprecated.
Templateable	createTemplate(TypeIdentifier objType, HashMap nameValueData, Locale locale) Deprecated.
HashMap	getCheckinTemplateAttributes(Templateable object, HashMap hashMap, Locale locale) Deprecated.
HashMap	getCreateFromTemplateAttributes(WTContainer context, Templateable objTemplate, HashMap hashMap, Locale locale) Deprecated.
HashMap	getCreateTemplateAttributes(WTContainer context, TypeIdentifier objType, HashMap hashMap, Locale locale) Deprecated.
HashMap	getDetailsTemplateAttributes(Templateable object, HashMap hashMap, ClientConfiguration clientInfo, Locale locale) Deprecated.
Persistable[]	getTemplates(Class objClass, String context, Locale locale) Deprecated.
TypeIdentifier[]	getTemplateTypes(Class objClass, String context, Locale locale) Deprecated.
HashMap	getUpdateTemplateAttributes(Templateable object, HashMap hashMap, Locale locale) Deprecated.

Method Detail

createFromTemplate

public Templateable createFromTemplate(Templateable objTemplate,
                                       HashMap nameValueData,
                                       Locale locale,
                                       String applicationName)
                                throws WTException

Deprecated.

Create an object from a template object and persist it. Uses the copy or save as functionality to execute the copy and then uses the download to download the template content from the original object if it is a FormatContentHolder.

Supported API: false

Parameters:

objTemplate - The template to create the object from.

nameValueData - Name value pairs from the UI.

locale - The locale of the client, used to return some of the strings in the locale of the client.

applicationName - Name of application to branch on to the different delegates for the checkout of the document. This is not used to branch on for any of the template objects.

Returns:

Templateable

Throws:

WTException

createTemplate

public Templateable createTemplate(TypeIdentifier objType,
                                   HashMap nameValueData,
                                   Locale locale)
                            throws WTException

Deprecated.

Create an object that will be used as a template object and persist it. This new object will be stored in a cabinet based on the context that this operation is started in. A file should be uploaded into this object to form the template content after this api returns the object if it is a FormatContentHolder.

Supported API: false

Parameters:

objType - Soft type to use for the new template.

nameValueData - Name value pairs of data from the UI.

locale - The locale of the client, used to return some of the strings in the locale of the client.

Returns:

Templateable

Throws:

WTException

getTemplates

public Persistable[] getTemplates(Class objClass,
                                  String context,
                                  Locale locale)
                           throws WTException

Deprecated.

Return a vector to represent the template list.

Supported API: false

Parameters:

objClass - The class of the object that the template list is requested for.

context - The product or repository that this is requested from.

locale - The locale of the client, used to return some of the strings in the locale of the client.

Returns:

Persistable[]

Throws:

WTException

getTemplateTypes

public TypeIdentifier[] getTemplateTypes(Class objClass,
                                         String context,
                                         Locale locale)
                                  throws WTException

Deprecated.

Return an array of the types of document that a template can be created with. For create template.

Supported API: false

Parameters:

objClass - The class of the object that the template list is requested for.

context - The product or repository that this is requested from.

locale - The locale of the client, used to return some of the strings in the locale of the client.

Returns:

TypeIdentifier[]

Throws:

WTException

getCreateTemplateAttributes

public HashMap getCreateTemplateAttributes(WTContainer context,
                                           TypeIdentifier objType,
                                           HashMap hashMap,
                                           Locale locale)
                                    throws WTException

Deprecated.

Return a list of the modeled attributes that need to be populated for a create.

Supported API: false

Parameters:

context - Container to create the document in.

objType - Soft type to use for the new document.

hashMap - Either a started hash map for the data or null if one is to be created inside of this method.

locale - The locale of the client, used to return some of the strings in the locale of the client.

Returns:

HashMap

Throws:

WTException

getCreateFromTemplateAttributes

public HashMap getCreateFromTemplateAttributes(WTContainer context,
                                               Templateable objTemplate,
                                               HashMap hashMap,
                                               Locale locale)
                                        throws WTException

Deprecated.

Return a list of the modeled attributes that need to be populated for a create.

Supported API: false

Parameters:

context - Container to create the document in.

objTemplate - The template to create the object from.

hashMap - Either a started hash map for the data or null if one is to be created inside of this method.

locale - The locale of the client, used to return some of the strings in the locale of the client.

Returns:

HashMap

Throws:

WTException

getUpdateTemplateAttributes

public HashMap getUpdateTemplateAttributes(Templateable object,
                                           HashMap hashMap,
                                           Locale locale)
                                    throws WTException

Deprecated.

Return a list of the modeled attributes that need to be populated for an update document template.

Supported API: false

Parameters:

object - The template to be updated.

hashMap - Either a started hash map for the data or null if one is to be created inside of this method.

locale - The locale of the client, used to return some of the strings in the locale of the client.

Returns:

HashMap

Throws:

WTException

getDetailsTemplateAttributes

public HashMap getDetailsTemplateAttributes(Templateable object,
                                            HashMap hashMap,
                                            ClientConfiguration clientInfo,
                                            Locale locale)
                                     throws WTException

Deprecated.

Return a list of the modeled attributes that need to be populated for the details page of a document template.

Supported API: false

Parameters:

object - The template to be displayed.

hashMap - Either a started hash map for the data or null if one is to be created inside of this method.

clientInfo - Information from the client application.

locale - The locale of the client, used to return some of the strings in the locale of the client.

Returns:

HashMap

Throws:

WTException

getCheckinTemplateAttributes

public HashMap getCheckinTemplateAttributes(Templateable object,
                                            HashMap hashMap,
                                            Locale locale)
                                     throws WTException

Deprecated.

Return a list of the modeled attributes that need to be populated for a checkin document template.

Supported API: false

Parameters:

object - The template to be checked in.

hashMap - Either a started hash map for the data or null if one is to be created inside of this method.

locale - The locale of the client, used to return some of the strings in the locale of the client.

Returns:

HashMap

Throws:

WTException