com.ptc.windchill.enterprise.doc.server
Class WTDocumentTemplateProjectDelegate

java.lang.Object
  com.ptc.windchill.enterprise.doc.server.WTDocumentTemplateDelegate
      com.ptc.windchill.enterprise.doc.server.WTDocumentTemplateProjectDelegate

All Implemented Interfaces:

Serializable, TemplateObjectDelegate

public class WTDocumentTemplateProjectDelegate

extends WTDocumentTemplateDelegate

implements Serializable

Document template processing specific to ProjectLink or the site and org levels for PDMLink.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CHECKIN_TEMPLATE
private static String	CLASSNAME
private static String	CREATE_FROM_TEMPLATE
private static String	CREATE_TEMPLATE
private static String	DISPLAY_TEMPLATE
private static String	RESOURCE
private static String	UPDATE_TEMPLATE
private static boolean	VERBOSE

Fields inherited from class com.ptc.windchill.enterprise.doc.server.WTDocumentTemplateDelegate

Constructor Summary

WTDocumentTemplateProjectDelegate()

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) Return a list of the modeled attributes that need to be populated for a checkin document template.
HashMap	getCreateFromTemplateAttributes(WTContainer context, Templateable objTemplate, HashMap hashMap, Locale locale) Return a list of the modeled attributes that need to be populated for a create.
HashMap	getCreateTemplateAttributes(WTContainer context, TypeIdentifier objType, HashMap hashMap, Locale locale) Return a list of the modeled attributes that need to be populated for a create.
HashMap	getDetailsTemplateAttributes(Templateable object, HashMap hashMap, ClientConfiguration clientInfo, Locale locale) Return a list of the modeled attributes that need to be populated for the details page of a document template.
private String[]	getProjectSpecificAttributes(String operation)
HashMap	getUpdateTemplateAttributes(Templateable object, HashMap hashMap, Locale locale) Return a list of the modeled attributes that need to be populated for an update document template.

Methods inherited from class com.ptc.windchill.enterprise.doc.server.WTDocumentTemplateDelegate

getCheckinDocumentAttributes, getCreateFromTemplateAttributes, getCreateTemplateAttributes, getDetailsDocumentAttributes, getTemplates, getTemplateTypes, getUnpersistedDocumentFromTemplate, getUnpersistedTemplate, getUpdateDocumentAttributes, persistDocumentFromTemplate, persistDocumentTemplate

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

CREATE_FROM_TEMPLATE

private static final String CREATE_FROM_TEMPLATE

See Also:

Constant Field Values

CREATE_TEMPLATE

private static final String CREATE_TEMPLATE

See Also:

Constant Field Values

UPDATE_TEMPLATE

private static final String UPDATE_TEMPLATE

See Also:

Constant Field Values

DISPLAY_TEMPLATE

private static final String DISPLAY_TEMPLATE

See Also:

Constant Field Values

CHECKIN_TEMPLATE

private static final String CHECKIN_TEMPLATE

See Also:

Constant Field Values

VERBOSE

private static boolean VERBOSE

Constructor Detail

WTDocumentTemplateProjectDelegate

public WTDocumentTemplateProjectDelegate()

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

Specified by:

createFromTemplate in interface TemplateObjectDelegate

Overrides:

createFromTemplate in class WTDocumentTemplateDelegate

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

Specified by:

createTemplate in interface TemplateObjectDelegate

Overrides:

createTemplate in class WTDocumentTemplateDelegate

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

getCreateTemplateAttributes

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

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

Supported API: false

Specified by:

getCreateTemplateAttributes in interface TemplateObjectDelegate

Overrides:

getCreateTemplateAttributes in class WTDocumentTemplateDelegate

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

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

Supported API: false

Specified by:

getCreateFromTemplateAttributes in interface TemplateObjectDelegate

Overrides:

getCreateFromTemplateAttributes in class WTDocumentTemplateDelegate

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

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

Supported API: false

Specified by:

getUpdateTemplateAttributes in interface TemplateObjectDelegate

Overrides:

getUpdateTemplateAttributes in class WTDocumentTemplateDelegate

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

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

Supported API: false

Specified by:

getDetailsTemplateAttributes in interface TemplateObjectDelegate

Overrides:

getDetailsTemplateAttributes in class WTDocumentTemplateDelegate

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

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

Supported API: false

Specified by:

getCheckinTemplateAttributes in interface TemplateObjectDelegate

Overrides:

getCheckinTemplateAttributes in class WTDocumentTemplateDelegate

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

getProjectSpecificAttributes

private String[] getProjectSpecificAttributes(String operation)