wt.lifecycle
Class AugmentRolesProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.lifecycle.AugmentRolesProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class AugmentRolesProcessor

extends BasicTemplateProcessor

Provide Windchill script support for the AugmentRoles html template.

Supported API: false

Extendable: false

See Also:

BasicTemplateProcessor, Serialized Form

Field Summary

private static String	CLASSNAME
private static String	LIFECYCLE_VERBOSE_FLAG
private static String	MAIN_HTML_TEMPLATE
private static String	METHODNAME
private LifeCycleManaged	myObject
private Phase	myPhase
private static String	PDML_MAIN_HTML_TEMPLATE
private static String	RESOURCE
private static String	ROW_HTML_TEMPLATE
private static boolean	VERBOSE

Fields inherited from class wt.enterprise.BasicTemplateProcessor

ACTION, ADD_HELP_ICON, ALL_CABINETS, BLANK_SPACE, BREAK_SEPARATOR, BREAK_TAG, CLASS, componentFactory, CONTAINER_NAME, CONTENT_RESOURCE, contextClass, DEFAULT_CHARSET, DEFAULT_HELP_ICON_SELECTOR, DEFAULT_HELP_LABEL, DEFAULT_PREFERENCE_CONTEXT, DOCFROMTEMPLATE, ENABLE_HELP_ICON_PROPERTY_NAME, ENTERPRISE_SEARCH, EXTERNALIZATION_VERSION_UID, FEDERATION_SEARCH, GLOBAL_NAVIGATION_ENABLE_HELP_ICON, globalNavBarHelpIconEnabledDefault, HELP_CONTEXT, HELP_ICON_POSITION, HELP_ICON_SELECTOR, HELP_LABEL, HELP_LABEL_RESOURCE, HELP_WINDOW_NAME, helpContext, helpIconEnabled, helpIconEnabledDefault, HOMEPAGE, IDPREFIX, IMPORT, INTEGRATED_SEARCH, isDndMicroAppletEnabled, isDndMicroAppletEnabledInitialized, LABEL_SEPARATOR, LINE_FEED_DELIMITER, linkPrefix, LOCAL_SEARCH, OID, OLD_FORMAT_VERSION_UID, pageContext, PDMLINK_INSTALL_KEY, PERSONAL_CABINET, PREF_WINDOW_NAME, PREFERENCE_CONTEXT, PRESENT_HELP_LABEL, PROJECTLINK_INSTALL_KEY, SEARCH, SHARE_ICON, TEXT_RESOURCE_BUNDLE, URL_RESOURCE, WORKLIST, wtAttribute, WTCORE_IMAGE_DIR

Fields inherited from interface wt.templateutil.processor.ContextTranslator

CONTEXT_LIST_IN, CONTEXT_LIST_OUT

Fields inherited from interface wt.templateutil.processor.ContextHolder

CONTEXT_ACTION, CONTEXT_CLASS_NAME, CONTEXT_OBJ, CONTEXT_PROPERTIES, FORM_DATA, QUERY_DATA, RESPONSE_EXCEPTIONS, RESPONSE_FOOTERS, RESPONSE_HEADERS, RESPONSE_MESSAGES, RESPONSE_STRING, STATUS

Constructor Summary

AugmentRolesProcessor()
A no argument constructor.

AugmentRolesProcessor(LifeCycleManaged lcm)
Constructs a AugmentRolesProcessor object.

Method Summary

void	appletOid(Properties properties, Locale locale, OutputStream os) Return the oid applet parameter.
static void	buildAugmentRoles(HTTPRequest req, HTTPResponse resp) Create the Augment Roles window.
static String	buildUrl(LifeCycleManaged object) Constructs a URL that links to the Augment Roles.
void	getAppletParameters(Properties properties, Locale locale, OutputStream os) Include the parameters of the applet
(package private) static LifeCycleManaged	getLCMObject(String oid) This method will return the LifeCycleManaged object for the given oid.
HTMLTemplate	getTemplate(Vector preferences) Return an initialized HTMLTemplate.
void	handleRequest(HTTPRequest req, HTTPResponse resp) This method handles HTTP GET requests to produce an HTML page for the context object.
void	updateTeamURL(Properties properties, Locale locale, OutputStream os) This method will produce a url to update the team object for the given context object.

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, addHiddenProperty, addHTMLHelpLink, addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, allVersions, bcwti, buildFormProcessorURL, buildFormProcessorURL, comment, createActionsBar, createFederationNavigationBar, createGlobalNavigationBar, createNavigationBar, createParentFolderLink, currentTimestamp, displayAllCabinets, displayAttributeName, displayAttributesTable, displayAttributeValue, displayFolderContents, displayFolderObject, displayFolderTrail, displayGoToLatestLink, displayOrganizationIdentifier, displayPendingChangeIndicator, displayStyleSheetAttributesTable, displayVisualData, formatDate, getActionPairs, getAllCabinetsURL, getBaselineItems, getCharsetEncoding, getCheckedOutFolderURL, getClassIcon, getClassInfo, getContextAction, getContextClass, getContextClassName, getContextListIn, getContextListOut, getContextObj, getContextProperties, getContextServiceName, getDisplayName, getDomainPath, getEnabledVersion, getEncoding, getFederationSearchURL, getFolderLocation, getFolderPath, getFormData, getGenericInstanceIconImgTag, getGlyphImageTag, getGlyphsArray, getGlyphTagsNoDnD, getHelpContext, getHomepageURL, getHTMLComponentFactory, getHTMLHelpLink, getHTMLHelpURL, getHTMLHelpURL, getHTMLTableService, getIconResource, getIconResource, getIconResource, getIconSelector, getId, getJavaScriptManager, getLocalizedDateFormatMessage, getLocalizedMessage, getLocalizedPrintWriter, getLocalizedString, getObjectDnDIcon, getObjectIcon, getObjectIconDnDTag, getObjectIconGlyphs, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectIconImgTag, getObjectPropertyValueString, getObjectPropertyValueString, getPageContext, getParentFolderLink, getPersonalCabinet, getPersonalCabinetURL, getPreferenceValue, getPrincipalEmailLink, getPrincipalEmailLink, getPrintWriter, getPropertyFromPropertyFile, getQuery, getQueryData, getReferenceString, getReferenceString, getResourceString, getResourceString, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getResponseString, getSearchCriteriaURL, getSearchCriteriaURL, getSearchResultsURL, getShareImage, getShareImage, getState, getStatus, getStringFromResourceBundle, getStringFromResourceBundle, getTemplateDisplayGeneral, getTrailId, getTrlIdAttribute, getURLActions, getURLActions, getURLActions, getURLActions, getURLActionsString, getURLActionsString, getURLFactory, getURLFromDelegate, getURLProcessorLink, getURLProcessorLink, getURLProcessorLink, getURLProcessorLinkWithLabel, getUsedByLinks, getWCColor, getWCColor, getWCColorDec, getWCColorDec, getWCFontFamily, getWCFontFamily, getWorklistURL, getWTAttribute, getWTContainerByName, getWTContainerRef, handleExceptionTP, handleExceptionTP, handleProcessorException, hiddenContextString, include, initJavaScriptManager, isDndMicroAppletEnabled, isEqual, listContent, objectActionLink, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectActionLinkAux, objectBackground, objectIdentification, objectIdentifier, objectProperties, objectPropertyName, objectPropertyNameAux, objectPropertyNameAux2, objectPropertyValue, objectPropertyValueAux, objectPropertyValueAux2, objectPropertyValueString, outputLink, outputPropertyFromPropertyFile, parameterValue, partUsedBy, PDMLinkIsInstalled, printQueryTable, printTable, printTextArea, processSubTemplate, readContext, readExternal, readVersion, setColumnProperties, setContextAction, setContextClass, setContextClassName, setContextListIn, setContextListOut, setContextObj, setContextProperties, setFormData, setHelpContext, setHTMLTableService, setJavaScriptManager, setPageContext, setQueryData, setResponseExceptions, setResponseFooters, setResponseHeaders, setResponseMessages, setResponseString, setState, setStatus, showResponseExceptions, showResponseFooters, showResponseHeaders, showResponseMessage, showResponseMessages, showVersions, sortQueryResult, splitStringIntoTokens, tableService, translateToHtml, useProcessorService, visualizationIsEnabled, writeExternal, writeHiddenContext, writeQueryStringContext

Methods inherited from class java.lang.Object

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

Field Detail

CLASSNAME

private static String CLASSNAME

METHODNAME

private static String METHODNAME

MAIN_HTML_TEMPLATE

private static String MAIN_HTML_TEMPLATE

PDML_MAIN_HTML_TEMPLATE

private static String PDML_MAIN_HTML_TEMPLATE

ROW_HTML_TEMPLATE

private static String ROW_HTML_TEMPLATE

LIFECYCLE_VERBOSE_FLAG

private static String LIFECYCLE_VERBOSE_FLAG

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

myObject

private LifeCycleManaged myObject

myPhase

private Phase myPhase

VERBOSE

private static final boolean VERBOSE

Constructor Detail

AugmentRolesProcessor

public AugmentRolesProcessor(LifeCycleManaged lcm)

Constructs a AugmentRolesProcessor object. The AugmentRolesProcessor object is the context object used when building the Augment Roles window.

Parameters:

lcm - the LifeCycleManaged object of interest

AugmentRolesProcessor

public AugmentRolesProcessor()

A no argument constructor.

Method Detail

buildUrl

public static String buildUrl(LifeCycleManaged object)
                       throws WTException

Constructs a URL that links to the Augment Roles. This is a convenience method for anyone that has to launch the Augment Roles Window.

Parameters:

object - The LifeCycleManaged object to Augment the roles of d

Throws:

WTException - throws WTException if the URL cannot be built

handleRequest

public void handleRequest(HTTPRequest req,
                          HTTPResponse resp)
                   throws WTException

This method handles HTTP GET requests to produce an HTML page for the context object.

Parameters:

req -

resp -

Throws:

WTException

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Return an initialized HTMLTemplate.

Throws:

WTException

buildAugmentRoles

public static void buildAugmentRoles(HTTPRequest req,
                                     HTTPResponse resp)
                              throws IOException

Create the Augment Roles window. This method handles HTTP GET requests to produce an HTML page which lists the Augment Roles of a LifeCycle Managed Object. The format of the HTML output is determined by the AugmentRoles html template.

Parameters:

req - HTTPRequest

resp - HTTPResponse

Throws:

IOException

getAppletParameters

public void getAppletParameters(Properties properties,
                                Locale locale,
                                OutputStream os)
                         throws WTException

Include the parameters of the applet

Parameters:

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException

appletOid

public void appletOid(Properties properties,
                      Locale locale,
                      OutputStream os)
               throws WTException

Return the oid applet parameter.

Parameters:

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException

updateTeamURL

public void updateTeamURL(Properties properties,
                          Locale locale,
                          OutputStream os)
                   throws WTException

This method will produce a url to update the team object for the given context object. This method was moved from a duplicate PDMLink class and should remain here to support PDMLink functionality.

Parameters:

properties - The arguments that were passed to the Windchill script call.

locale - The Locale to send to the invoked methods for localization.

os - The output stream.

Throws:

WTException

getLCMObject

static LifeCycleManaged getLCMObject(String oid)
                              throws Exception

This method will return the LifeCycleManaged object for the given oid. This method was moved from a duplicate PDMLink class and should remain here to support PDMLink functionality.

Throws:

Exception