com.ptc.windchill.enterprise.search.client
Class CoSimpleWindchillHelpHyperLinkProducer

java.lang.Object
  com.ptc.core.ca.co.client.element.CoElementHandler
      com.ptc.core.ca.co.client.windchill.CoWindchillHyperLinkProducer
          com.ptc.windchill.enterprise.search.client.CoSimpleWindchillHelpHyperLinkProducer

All Implemented Interfaces:

CoModelHandler

Direct Known Subclasses:

CoSimpleWindchillTutorialHyperLinkProducer

public class CoSimpleWindchillHelpHyperLinkProducer

extends CoWindchillHyperLinkProducer

This class implements model handler for the hyperlink element to provide links to any windchill help resource. The class uses "simple" approach to locate an object and provide its oid as a paramenter on the url.

Supported API: true

Extendable: true

Field Summary

private static String	CLASSNAME
private static String	RESOURCE

Fields inherited from class com.ptc.core.ca.co.client.element.CoElementHandler

Constructor Summary

CoSimpleWindchillHelpHyperLinkProducer()

Method Summary

protected String	getLocaleSpecificHelpResource(String resource, Locale locale, CoEnvData envData) Returns the locale specific path to a help resource (Help file or Tutorial) Supported API: true
void	updateModel(CoElement element, CoEnvData envData) Creates and updates the model of the element.

Methods inherited from class com.ptc.core.ca.co.client.windchill.CoWindchillHyperLinkProducer

getParams

Methods inherited from class com.ptc.core.ca.co.client.element.CoElementHandler

equals, getClassName, hashCode, setClassName

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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

Constructor Detail

CoSimpleWindchillHelpHyperLinkProducer

public CoSimpleWindchillHelpHyperLinkProducer()

Method Detail

updateModel

public void updateModel(CoElement element,
                        CoEnvData envData)
                 throws WTException

Creates and updates the model of the element.

Supported API: true

Specified by:

updateModel in interface CoModelHandler

Overrides:

updateModel in class CoWindchillHyperLinkProducer

Parameters:

element -

envData -

Throws:

WTException

getLocaleSpecificHelpResource

protected String getLocaleSpecificHelpResource(String resource,
                                               Locale locale,
                                               CoEnvData envData)
                                        throws WTException

Returns the locale specific path to a help resource (Help file or Tutorial)

Supported API: true

Parameters:

resource -

locale -

envData -

Returns:

String

Throws:

WTException