wt.clients.homepage
Class WindchillHome

java.lang.Object
  wt.clients.homepage.WindchillHome

All Implemented Interfaces:

CGIConstants

public class WindchillHome
extends Object
implements CGIConstants

WindchillHome contains those methods needed to dynamically generate the main Windchill page.

Supported API: true
Extendable: true

Method Summary

static void	getPage(HTTPRequest req, HTTPResponse resp) Construct the main Windchill page.
static void	getPageName(Properties prop, Locale locale, OutputStream os) This method is invoked when dynamically generating the main Windchill page.
static void	insertHomeLocation(Properties prop, Locale locale, OutputStream os) This method's function is to get and write out the URL of the Home page.
static void	insertLocalSearchLocation(Properties prop, Locale locale, OutputStream os) This method is invoked dynamically when generating the main Windchill page.
static void	insertPageLocation(Properties prop, Locale locale, OutputStream os) This method is invoked when dynamically generating the main Windchill page.
static void	insertSALocation(Properties prop, Locale locale, OutputStream os) This method is invoked when dynamically generating the main Windchill page.
static void	insertWorkflowLocation(Properties prop, Locale locale, OutputStream os) This method is invoked when dynamically generating the main Windchill page.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPage

public static void getPage(HTTPRequest req,
                           HTTPResponse resp)
                    throws WTException

Construct the main Windchill page. This method causes the main Windchill page to be dynamically generated.

Supported API: true

Parameters:

req - The HTTPRequest.

resp - The HTTPResponse object. This object holds the OutputStream to write to.

Throws:

WTException - Thrown if an IO error occurs.

insertHomeLocation

public static void insertHomeLocation(Properties prop,
                                      Locale locale,
                                      OutputStream os)
                               throws WTException

This method's function is to get and write out the URL of the Home page.

Supported API: true

Parameters:

prop - Properties used by this method. This parameter is not checked as it is expected to be null.

locale - The prefered Locale of the client. Since this method only writes out a URL, this parameter is not checked.

os - The OutputStream to write the URL to.

Throws:

WTException - Thrown if the URL cannot be obtained.

insertSALocation

public static void insertSALocation(Properties prop,
                                    Locale locale,
                                    OutputStream os)
                             throws WTException

This method is invoked when dynamically generating the main Windchill page. It's function is to get and write out the URL of the System Administration page.

Supported API: true

Parameters:

prop - Properties used by this method. This parameter is not checked as it is expected to be null.

locale - The prefered Locale of the client. Since this method only writes out a URL, this parameter is not checked.

os - The OutputStream to write the URL to.

Throws:

WTException - Thrown if the URL cannot be obtained.

insertWorkflowLocation

public static void insertWorkflowLocation(Properties prop,
                                          Locale locale,
                                          OutputStream os)
                                   throws WTException

This method is invoked when dynamically generating the main Windchill page. It's function is to get and write out the URL of the Worklist Processor page.

Supported API: true

Parameters:

prop - Properties used by this method. This parameter is not checked as it is expected to be null.

locale - The prefered Locale of the client. Since this method only writes out a URL, this parameter is not checked.

os - The OutputStream to write the URL to.

Throws:

WTException - Thrown if the URL cannot be obtained.

insertLocalSearchLocation

public static void insertLocalSearchLocation(Properties prop,
                                             Locale locale,
                                             OutputStream os)
                                      throws WTException

This method is invoked dynamically when generating the main Windchill page. It's function is to get and write out the URL to the Local Search page.

Supported API: true

Parameters:

prop - Properties used by this method.

locale - The prefered Locale of the client. Since this method only writes out a URL, this parameter is not checked.

os - The OutputStream to write the URL to.

Throws:

WTException - Thrown if the URL cannot be obtained.

insertPageLocation

public static void insertPageLocation(Properties prop,
                                      Locale locale,
                                      OutputStream os)
                               throws WTException

This method is invoked when dynamically generating the main Windchill page. It's function is to get and write out the location (URL) of the given page. This location uses the server codebase as defined in the wt.properties file.

Supported API: true

Parameters:

prop - Properties used by this method. This parameter contains the page to for which to make the URL.

locale - The prefered Locale of the client. Since this method only writes out a URL, this parameter is not checked.

os - The OutputStream to write the URL to.

Throws:

WTException - Thrown if the server codebase property cannot be obtained.

getPageName

public static void getPageName(Properties prop,
                               Locale locale,
                               OutputStream os)
                        throws WTException

This method is invoked when dynamically generating the main Windchill page. It's function is to get and write out a unique name for the given page. This page name uses the wt.server.id as defined in the wt.properties file.

Supported API: true

Parameters:

prop - Properties used by this method. This parameter contains the name to append to the value of wt.server.id.

locale - The prefered Locale of the client. Since this method only writes out a non-visible, this parameter is not checked.

os - The OutputStream to write the page name to.

Throws:

WTException - Thrown if the wt.server.id property cannot be obtained.