com.ptc.windchill.enterprise.nativeapp.server
Interface ApplicationAttributeMapperDelegate

All Known Implementing Classes:

DefaultAttributeMapper, MSOIAttributeMapper

public interface ApplicationAttributeMapperDelegate

Translate back and forth from Windchill attribute names to an application like Microsoft Office Integration attribute names.

Supported API: false

Extendable: false

Method Summary

ClientConfiguration	getClientConfiguration(Locale locale) Return the configuration information for this specific application.
HashMap	getObjectAttributes(WTObject object, Locale locale) From a WTObject return a Hashmap which contains the name value pairs of the attributes from the application and the values.
HashMap	getSpecificObjectAttributes(WTObject object, String[] attributeList, Locale locale) From a WTObject return a Hashmap which contains the name value pairs of the attributes from the application and the values.
HashMap	mapToApplicationNames(WTObject object, HashMap nameValueData) Pass in the HashMap of name/values of Windchill attributes and return the HashMap of the corresponding Application names to the values.
HashMap	mapToWindchillNames(WTObject object, HashMap nameValueData, Locale locale) Pass in the HashMap of name/values from the application attributes and return the HashMap of the corresponding Windchill names to the values.

Method Detail

getObjectAttributes

public HashMap getObjectAttributes(WTObject object,
                                   Locale locale)
                            throws WTException

From a WTObject return a Hashmap which contains the name value pairs of the attributes from the application and the values. These are not Windchill attribute names.

Supported API: false

Parameters:

object -

locale - The locale of the client, so that any attributes values that need to be processed for display can be handled.

Returns:

HashMap

Throws:

WTException

mapToWindchillNames

public HashMap mapToWindchillNames(WTObject object,
                                   HashMap nameValueData,
                                   Locale locale)
                            throws WTException

Pass in the HashMap of name/values from the application attributes and return the HashMap of the corresponding Windchill names to the values.

Supported API: false

Parameters:

object - Soft type to use for the document.

nameValueData - Name value pairs of application attributes to map to Windchill name value pairs.

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

Returns:

HashMap

Throws:

WTException

mapToApplicationNames

public HashMap mapToApplicationNames(WTObject object,
                                     HashMap nameValueData)
                              throws WTException

Pass in the HashMap of name/values of Windchill attributes and return the HashMap of the corresponding Application names to the values.

Supported API: false

Parameters:

object - Document object to use as soft type.

nameValueData - Name value pairs of Windchill attributes to map to application name value pairs.

Returns:

HashMap

Throws:

WTException

getClientConfiguration

public ClientConfiguration getClientConfiguration(Locale locale)
                                           throws WTException

Return the configuration information for this specific application.

Supported API: false

Parameters:

locale - Locale of the client.

Returns:

ClientConfiguration

Throws:

WTException

getSpecificObjectAttributes

public HashMap getSpecificObjectAttributes(WTObject object,
                                           String[] attributeList,
                                           Locale locale)
                                    throws WTException

From a WTObject return a Hashmap which contains the name value pairs of the attributes from the application and the values. These are not Windchill attribute names. This method accepts a list of attributes that are required and only returns those attributes.

Supported API: false

Parameters:

object -

attributeList - List of Windchill names for attributes to be returned. Some of these attributes are made up names to get at specific information that processing has been added to this method to handle.

locale - The locale of the client, so that any attributes values that need to be processed for display can be handled.

Returns:

HashMap

Throws:

WTException