wt.enterprise
Class ReferencedByProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.enterprise.ReferencedByProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class ReferencedByProcessor

extends BasicTemplateProcessor

This class provides methods to process URLs and determine the action to be taken via the arguments of the URL.

The arguments to the URL are an "action" and an "oid". The method specified in the URL will use the arguments and possibly an application context service (wt.services.applicationcontext.*) to determine what to do next.

Generally this class will not be used directly, but instead will be instantiated via the TemplateProcessor.objectActionLink() method.

Supported API: true

Extendable: false

See Also:

TemplateProcessor, Serialized Form

Field Summary

private static String	CODEBASE
private boolean	emptyMessage
private static int	PAGE_EXPIRATION
private static String	RESOURCE
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, serialVersionUID, 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

ReferencedByProcessor()

Method Summary

String	addLink(WTPart part, boolean show_image) Get an HTML link to the part.
static void	getReferencedByTable(HTTPRequest req, HTTPResponse resp) Given an "action" and "oid" uses an application context service to determine a template processor to apply to the object specified by the oid.
HTMLTemplate	getTemplate(Vector preferences) Returns the initialized template templates/objectProperties/ReferencedByTable.
void	handleRequest(HTTPRequest req, HTTPResponse resp) Given an "action" and "oid" uses an application context service to determine a template processor to apply to the object specified by the oid.
void	printTableRow(WTPart part, PrintWriter out, Locale locale) Prints a row based on the part.
void	referencedByTable(Properties parameters, Locale locale, OutputStream os)
void	setEmptyMessage(boolean empty_message) Sets the empty message flag.

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

CODEBASE

private static String CODEBASE

VERBOSE

private static boolean VERBOSE

PAGE_EXPIRATION

private static int PAGE_EXPIRATION

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

emptyMessage

private boolean emptyMessage

Constructor Detail

ReferencedByProcessor

public ReferencedByProcessor()

Method Detail

getReferencedByTable

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

Given an "action" and "oid" uses an application context service to determine a template processor to apply to the object specified by the oid.

Supported API: true

Extendable: false

Parameters:

req - The HTTPRequest.

resp - The HTTPResponse

Throws:

WTException

handleRequest

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

Given an "action" and "oid" uses an application context service to determine a template processor to apply to the object specified by the oid.

Supported API: false

Extendable: false

Parameters:

req - The HTTPRequest.

resp - The HTTPResponse

Throws:

WTException

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Returns the initialized template templates/objectProperties/ReferencedByTable.

Supported API: false

Extendable: false

Parameters:

preferences - A Vector of preferences used to initialize the template.

Returns:

The initialized template templates/objectProperties/ReferencedByTable.

Throws:

WTException

referencedByTable

public void referencedByTable(Properties parameters,
                              Locale locale,
                              OutputStream os)
                       throws WTException

Throws:

WTException

printTableRow

public void printTableRow(WTPart part,
                          PrintWriter out,
                          Locale locale)
                   throws WTException

Prints a row based on the part.

Supported API: false

Extendable: false

Parameters:

part - The WTPart

out - The PrintWriter

locale - The Locale

Throws:

WTException

addLink

public String addLink(WTPart part,
                      boolean show_image)

Get an HTML link to the part.

Supported API: false

Extendable: false

Parameters:

part - The WTPart

show_image - Show the image if true.

Returns:

An HTML link to the part.

setEmptyMessage

public void setEmptyMessage(boolean empty_message)

Sets the empty message flag.

Supported API: false

Extendable: false

Parameters:

empty_message -