com.ptc.windchill.enterprise.doc.server
Interface DocumentDelegate

All Known Implementing Classes:

WTDocumentDelegate

public interface DocumentDelegate

Delegate for document specific methods.

Supported API: false

Extendable: false

Method Summary

WTDocument	createDocument(TypeIdentifier objType, HashMap nameValueData, Locale locale) Create a document from the input provided.
HashMap	getCheckinDocumentAttributes(Persistable object, HashMap hashMap, Locale locale) Return a list of the modeled attributes that can be updated along with their present values.
HashMap	getCreateDocumentAttributes(WTContainer context, TypeIdentifier objType, HashMap hashMap, Locale locale) Return a list of the modeled attributes that need to be populated for a create.
HashMap	getDetailsDocumentAttributes(Persistable object, HashMap hashMap, ClientConfiguration clientInfo, Locale locale) Return a list of the modeled/made up attributes that should be displayed on the details page.
TypeIdentifier[]	getDocumentType(Class objClass, String context) Return a vector of the types that are available for this context.
HashMap	getUpdateDocumentAttributes(Persistable object, HashMap hashMap, Locale locale) Return a list of the modeled attributes that can be updated along with their present values.
WTDocument	updateDocument(WTDocument document, HashMap nameValueData, Locale locale) Update a document from the input provided.

Method Detail

createDocument

public WTDocument createDocument(TypeIdentifier objType,
                                 HashMap nameValueData,
                                 Locale locale)
                          throws WTException

Create a document from the input provided. Override this method and add a properties entry for your new class and method to create new sub-classes of WTDocument.

Supported API: false

Parameters:

objType - Soft type to use for the new document.

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:

WTDocument

Throws:

WTException

updateDocument

public WTDocument updateDocument(WTDocument document,
                                 HashMap nameValueData,
                                 Locale locale)
                          throws WTException

Update a document from the input provided. Override this method and add a properties entry for your new class and method to create new sub-classes of WTDocument.

Supported API: false

Parameters:

document - The document to be updated.

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:

WTDocument

Throws:

WTException

getDocumentType

public TypeIdentifier[] getDocumentType(Class objClass,
                                        String context)
                                 throws WTException

Return a vector of the types that are available for this context.

Supported API: false

Parameters:

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

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

Returns:

TypeIdentifier[]

Throws:

WTException

getCreateDocumentAttributes

public HashMap getCreateDocumentAttributes(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

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

getUpdateDocumentAttributes

public HashMap getUpdateDocumentAttributes(Persistable object,
                                           HashMap hashMap,
                                           Locale locale)
                                    throws WTException

Return a list of the modeled attributes that can be updated along with their present values.

Supported API: false

Parameters:

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

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

getDetailsDocumentAttributes

public HashMap getDetailsDocumentAttributes(Persistable object,
                                            HashMap hashMap,
                                            ClientConfiguration clientInfo,
                                            Locale locale)
                                     throws WTException

Return a list of the modeled/made up attributes that should be displayed on the details page.

Supported API: false

Parameters:

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

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

getCheckinDocumentAttributes

public HashMap getCheckinDocumentAttributes(Persistable object,
                                            HashMap hashMap,
                                            Locale locale)
                                     throws WTException

Return a list of the modeled attributes that can be updated along with their present values.

Supported API: false

Parameters:

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

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