wt.notify
Class SubscriptionFormProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              wt.notify.SubscriptionFormProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class SubscriptionFormProcessor

extends GenerateFormProcessor

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
protected static String	EVENT
protected static String	EVENT_VALUE
protected static String	EXPIRATION_TIME
static long	EXTERNALIZATION_VERSION_UID
private boolean	haveSubscriptions
protected static long	OLD_FORMAT_VERSION_UID
protected static boolean	PJL_INSTALLED
protected static String	RECIPIENT
private static String	REFRESH_ACTION
private static String	RESOURCE
(package private) static long	serialVersionUID
protected static String	SUBJECT
protected static String	SUBSCRIBE
protected static String	SUBSCRIPTION_ACTION
protected static String	unSUBSCRIBE
private static int	UPDATEABLE
private Vector	updateableSubscriptions
private static int	VIEW_ONLY
private Vector	viewOnlySubscriptions

Fields inherited from class wt.templateutil.processor.GenerateFormProcessor

DEFAULT_LIFECYCLE, ON_CHANGE_EVENT_NAME, TEAMTEMPLATE_INPUT_NAME

Fields inherited from class wt.templateutil.processor.DefaultTemplateProcessor

ACTION, CLASS, CODEBASE, LINE_FEED_DELIMITER, MESSAGE_SEPARATOR, OID, VERBOSE

Fields inherited from class wt.enterprise.BasicTemplateProcessor

ADD_HELP_ICON, ALL_CABINETS, BLANK_SPACE, BREAK_SEPARATOR, BREAK_TAG, 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, 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, linkPrefix, LOCAL_SEARCH, 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

SubscriptionFormProcessor()

Method Summary

void	createFormConstruct(Properties properties, Locale locale, OutputStream os) Output the HTML form tags.
void	createSubscriptionTable(Properties properties, Locale locale, OutputStream os) Output the table for creating subscription objects Supported API: false
void	createSubscriptionTablePrompt(Properties properties, Locale locale, OutputStream os) Output the instructions for creating subscriptions Supported API: false
void	currentUser(Properties properties, Locale locale, OutputStream os) Output the current user Supported API: false
void	getDate(Properties properties, Locale locale, OutputStream os)
private void	getSubscriptions()
void	modifiableSubscriptionTable(Properties properties, Locale locale, OutputStream os) Output the table for removing subscription objects Supported API: false
void	modifiableSubscriptionTablePrompt(Properties properties, Locale locale, OutputStream os) Output the instructions for removing subscriptions Supported API: false
void	pageTitle(Properties properties, Locale locale, OutputStream os) Output the subscription page title Supported API: false
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(SubscriptionFormProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	targetObjectLink(Properties parameters, Locale locale, OutputStream os)
void	viewOnlySubscriptionTable(Properties properties, Locale locale, OutputStream os) Output the table for displaying view only subscriptions - these cannot be removed.
void	viewOnlySubscriptionTablePrompt(Properties properties, Locale locale, OutputStream os) Output the label for the view only subscription table Supported API: false
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class wt.templateutil.processor.GenerateFormProcessor

addHiddenProperties, changedContextualValue, contextualValue, contextualValueEncoded, currentFolderId, currentFolderPath, enumeratedTypeMenu, enumeratedTypeMenuForClass, generateAction, generatePostURL, generateUpdatePostURL, getButtonText, getContentHolder, getContextualValue, getDefaultPath, getDelim, getDnDAppletTags, getEnumeratedTypeMenu, getFormat, getFormValueFromSession, getFormValueFromSession, getFormValueFromSessionWithEnumeratedPropertyDefault, getFormValueFromSessionWithPropertyDefault, getLastUpdated, getMessageURL, getObjectIdentity, getPreferenceValue, getPrimary, getPrimary, getPrimaryAttribute, getPrimaryChecksum, getPrimaryChecksum, getPrimaryDownloadURL, getPrimaryDownloadURL, getPrimaryFileName, getPrimaryFileName, getPrimaryOidString, getPrimaryOidString, getPrimaryUploadedFromPath, getPrimaryUploadedFromPath, getPrimaryUploadURL, getPrimaryUploadURL, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getSize, getTargetType, getURLTabLink, getWTContainerRef, handleRequest, holderUploadTable, listLifeCycles, listTeamTemplates, obtainFromCovertProperty, parentFolderPath, readVersion, selectFolderMenu, selectFolderMenuForContainers, setContentHolder

Methods inherited from class wt.templateutil.processor.DefaultTemplateProcessor

addHiddenProperty, addToFeedbackCookie, addToFeedbackCookie, getContextPropertyValue, getCurrentUrl, getFeedbackCookieExceptions, getFeedbackCookieMessages, getHtmlTemplateFactory, getMessageSeparator, getPAGE_EXPIRATION, getPageExpirationResource, getTemplate, getTemplateDisplay, hiddenContextString, readVersion, setContextPropertyValue, setHtmlTemplateFactory, setMethodContextProperty, setNameProcessor, setPAGE_EXPIRATION, setPageExpirationResource, writeHiddenContext, writeQueryStringContext

Methods inherited from class wt.enterprise.BasicTemplateProcessor

AccessOK, 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, handleExceptionTP, handleExceptionTP, handleProcessorException, 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, 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

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

REFRESH_ACTION

private static final String REFRESH_ACTION

See Also:

Constant Field Values

SUBSCRIPTION_ACTION

protected static final String SUBSCRIPTION_ACTION

See Also:

Constant Field Values

SUBSCRIBE

protected static final String SUBSCRIBE

See Also:

Constant Field Values

unSUBSCRIBE

protected static final String unSUBSCRIBE

See Also:

Constant Field Values

EXPIRATION_TIME

protected static final String EXPIRATION_TIME

See Also:

Constant Field Values

EVENT

protected static final String EVENT

See Also:

Constant Field Values

EVENT_VALUE

protected static final String EVENT_VALUE

See Also:

Constant Field Values

SUBJECT

protected static final String SUBJECT

See Also:

Constant Field Values

RECIPIENT

protected static final String RECIPIENT

See Also:

Constant Field Values

PJL_INSTALLED

protected static boolean PJL_INSTALLED

UPDATEABLE

private static final int UPDATEABLE

See Also:

Constant Field Values

VIEW_ONLY

private static final int VIEW_ONLY

See Also:

Constant Field Values

haveSubscriptions

private boolean haveSubscriptions

updateableSubscriptions

private Vector updateableSubscriptions

viewOnlySubscriptions

private Vector viewOnlySubscriptions

Constructor Detail

SubscriptionFormProcessor

public SubscriptionFormProcessor()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class GenerateFormProcessor

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class GenerateFormProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(SubscriptionFormProcessor thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

pageTitle

public void pageTitle(Properties properties,
                      Locale locale,
                      OutputStream os)

Output the subscription page title

Supported API: false

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.

currentUser

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

Output the current user

Supported API: false

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

createSubscriptionTablePrompt

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

Output the instructions for creating subscriptions

Supported API: false

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

createSubscriptionTable

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

Output the table for creating subscription objects

Supported API: false

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

WTPropertyVetoException

modifiableSubscriptionTablePrompt

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

Output the instructions for removing subscriptions

Supported API: false

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

modifiableSubscriptionTable

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

Output the table for removing subscription objects

Supported API: false

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

viewOnlySubscriptionTablePrompt

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

Output the label for the view only subscription table

Supported API: false

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

viewOnlySubscriptionTable

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

Output the table for displaying view only subscriptions - these cannot be removed.

Supported API: false

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

createFormConstruct

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

Output the HTML form tags.

Supported API: false

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

getSubscriptions

private void getSubscriptions()
                       throws WTException

Throws:

WTException

getDate

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

Throws:

WTException

targetObjectLink

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

Throws:

WTException