wt.templateutil.processor
Interface HelpDirectoryGenerator

All Known Implementing Classes:

NewHelpDirectoryGenerator, OldHelpDirectoryGenerator

public interface HelpDirectoryGenerator

Deprecation Notice: This class is still valid for this release, however this serves as advance notice that it will be removed in the future. All user interfaces built using the Windchill HTML Template Processing client architecture will be rewritten using a different framework in an upcoming release. This interface defines the two methods that are used by the HelpHTMLTemplateFactory to generate localized paths based on the current locale and the current relative path.

Supported API: true

Extendable: false

Method Summary

String	getCandidateDirectory(String localeString, String relativeFilePath) Deprecated.
String	getCandidateRelativePath(String localeString, String relativeFilePath) Deprecated.

Method Detail

getCandidateDirectory

public String getCandidateDirectory(String localeString,
                                    String relativeFilePath)

Deprecated.

Returns a Full path that is a localized, candidate path. The Full path is generated from the value of wt.home, the relative path, and the locale.

Supported API: true

Parameters:

localeString -

relativeFilePath -

Returns:

String

getCandidateRelativePath

public String getCandidateRelativePath(String localeString,
                                       String relativeFilePath)

Deprecated.

Returns a relative path that is a localized, candidate path from codebase to the help directory. The relative path is based on the value of the relative path passed in and the locale that is passed in.

Supported API: true

Parameters:

localeString -

relativeFilePath -

Returns:

String