wt.replication.unit.htmlGeneration
Class ExportUnitProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.replication.unit.htmlGeneration.ExportUnitProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class ExportUnitProcessor

extends BasicTemplateProcessor

This class provides object properties template processors.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CODEBASE
private String	pOID
private static WTProperties	properties
private static String	RESOURCE
private String	sItem
private String	sLink
private String	sUnit
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

ExportUnitProcessor()
A no argument constructor with no side effects.

Method Summary

void	createActionsBar(Properties parameters, Locale locale, OutputStream os) Override creatActionBar in order to set highted item in menu bar.
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 which describes properties of the contextual object of an ExportUnitProcessor instance.
void	scheduleUnit(Properties parameters, Locale locale, OutputStream os) Display UI for scheduling unit export.
void	showTitle(Properties parameters, Locale locale, OutputStream os) Display title

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, addHiddenProperty, addHTMLHelpLink, addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, allVersions, bcwti, buildFormProcessorURL, buildFormProcessorURL, comment, 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

properties

private static WTProperties properties

CODEBASE

private static String CODEBASE

VERBOSE

private static boolean VERBOSE

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

pOID

private String pOID

sLink

private String sLink

sUnit

private String sUnit

sItem

private String sItem

Constructor Detail

ExportUnitProcessor

public ExportUnitProcessor()

A no argument constructor with no side effects.

Supported API: false

Method Detail

handleRequest

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

This method handles HTTP GET requests to produce an HTML page which describes properties of the contextual object of an ExportUnitProcessor instance.

It is expected that this method will be called via the URLProcessor which would have been invoked via a URL created using an objectActionLink (defined by the BasicTemplateProcessor class) script call within an HTML template file.

The format of the HTML that is output is determined by an HTML template file. The template that is used is chosen from the templates directory based on the class of the contextual object, the locale and the parameters passed to the objectProperties call. The template file is chosen using the ExportUnitTemplateFactory.

Supported API: false

Parameters:

req - HTTPRequest

resp - HTTPResponse

Throws:

WTException

See Also:

URLProcessor, wt.enterprise.ExportUnitTemplateFactory

getTemplate

public HTMLTemplate getTemplate(Vector preferences)
                         throws WTException

Return an initialized HTMLTemplate.

Throws:

WTException

scheduleUnit

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

Display UI for scheduling unit export.

Throws:

WTException

showTitle

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

Display title

Throws:

WTException

createActionsBar

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

Override creatActionBar in order to set highted item in menu bar. Placed this logic in the processor to allow the use of one template for mutilple schedule operations - ie export, send, receive, and import.

Overrides:

createActionsBar in class BasicTemplateProcessor

Parameters:

parameters - the Properties which contains parameter values specified in the script call. Can contain values for the link color and background color of the table cells.

locale - the locale in which the links will be displayed

os - the OutputStream to write the table of links to.

Throws:

WTException - if an error occurs building the links to the actions