wt.projmgmt.monitor
Class ProjectNotificationProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.projmgmt.monitor.ProjectNotificationProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class ProjectNotificationProcessor

extends BasicTemplateProcessor

implements Externalizable

The ProjectNotificationProcessor class supports template processing for project notitication. The notification mostly concerns the notification of project events.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	ACTIVITY_CLASS_NAME
private static String	CLASSNAME
private static String	DELIVERABLE_CLASS_NAME
private ExecutionObject	execObject
private ObjectIdentifier	execObjectId
private static String	EXECUTION_RESOURCE
static long	EXTERNALIZATION_VERSION_UID
private static String	MILESTONE_CLASS_NAME
private static String	NOTIFY_RESOURCE
protected static long	OLD_FORMAT_VERSION_UID
private static String	PLAN_CLASS_NAME
private static String	PROXY_CLASS_NAME
private static String	RESOURCE
private static String	RESOURCE_RESOURCE
(package private) static long	serialVersionUID
private static String	SUBSCRIBE
private static String	SUBSCRIPTION_ACTION
private static String	SUMMARY_CLASS_NAME
private static String	unSUBSCRIBE

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, 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, 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

ProjectNotificationProcessor()
No arg constructor.

Method Summary

void	getDeadline(Properties params, Locale locale, OutputStream os) Returns localized string containing time of the occurrence of the deadline event.
ExecutionObject	getExecObject() Returns the execution object which is the target of this processor.
ObjectIdentifier	getExecObjectId() Gets the value of the attribute: execObjectId; Identifier of the object that is the subject of the notification.
void	getExecObjectName(Properties params, Locale locale, OutputStream os) Returns the execution object's name.
void	getExecObjectType(Properties params, Locale locale, OutputStream os) Returns localized string describing type of execution object, whether a project, an activity, a milestone or a deliverable.
private String	getFormattedTimestamp(Timestamp timestamp, Locale locale) Utility method to remove any enclosing quotes from the given String.
void	getNewEstimatedFinish(Properties params, Locale locale, OutputStream os) Returns localized string containing the name of the new estimated finish of a deliverable, project or activity.
void	getNewOwner(Properties params, Locale locale, OutputStream os) Returns the name of the new owner.
void	getNewPercentComplete(Properties params, Locale locale, OutputStream os) Returns localized string containing the name of the new completion percentage of a deliverable, project or activity.
void	getNewState(Properties params, Locale locale, OutputStream os) Returns localized string containing the name of the new state of a state transition.
void	getNewStatus(Properties params, Locale locale, OutputStream os) Returns localized string containing the name of the new execution status of a deliverable, project or activity.
void	getObjectName(Properties params, Locale locale, OutputStream os)
private ObjectIdentifier	getOid(Object obj)
private String	getType(ObjectIdentifier obj_id)
void	handleRequest(HTTPRequest request, HTTPResponse response) Supported API: false
void	projectLinkAttributes(Properties params, Locale locale, OutputStream os) 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(ProjectNotificationProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
protected String	removeEnclosingQuotes(String value) Utility method to remove any enclosing quotes from the given String.
void	setExecObjectId(ObjectIdentifier a_ExecObjectId) Sets the value of the attribute: execObjectId; Identifier of the object that is the subject of the notification.
void	unsubscribe(Properties params, Locale locale, OutputStream os) Generates unsubscription URL.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

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, 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, writeHiddenContext, writeQueryStringContext

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

execObjectId

private ObjectIdentifier execObjectId

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

EXECUTION_RESOURCE

private static final String EXECUTION_RESOURCE

RESOURCE_RESOURCE

private static final String RESOURCE_RESOURCE

execObject

private ExecutionObject execObject

SUBSCRIPTION_ACTION

private static final String SUBSCRIPTION_ACTION

See Also:

Constant Field Values

SUBSCRIBE

private static final String SUBSCRIBE

See Also:

Constant Field Values

unSUBSCRIBE

private static final String unSUBSCRIBE

See Also:

Constant Field Values

NOTIFY_RESOURCE

private static final String NOTIFY_RESOURCE

DELIVERABLE_CLASS_NAME

private static final String DELIVERABLE_CLASS_NAME

MILESTONE_CLASS_NAME

private static final String MILESTONE_CLASS_NAME

ACTIVITY_CLASS_NAME

private static final String ACTIVITY_CLASS_NAME

SUMMARY_CLASS_NAME

private static final String SUMMARY_CLASS_NAME

PLAN_CLASS_NAME

private static final String PLAN_CLASS_NAME

PROXY_CLASS_NAME

private static final String PROXY_CLASS_NAME

Constructor Detail

ProjectNotificationProcessor

public ProjectNotificationProcessor()

No arg constructor.

Supported API: false

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 BasicTemplateProcessor

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 BasicTemplateProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ProjectNotificationProcessor 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

getExecObjectId

public ObjectIdentifier getExecObjectId()

Gets the value of the attribute: execObjectId; Identifier of the object that is the subject of the notification.

Supported API: false

Returns:

ObjectIdentifier

setExecObjectId

public void setExecObjectId(ObjectIdentifier a_ExecObjectId)
                     throws WTPropertyVetoException

Sets the value of the attribute: execObjectId; Identifier of the object that is the subject of the notification.

Supported API: false

Parameters:

a_ExecObjectId -

Throws:

WTPropertyVetoException

handleRequest

public void handleRequest(HTTPRequest request,
                          HTTPResponse response)

Supported API: false

Specified by:

handleRequest in interface TemplateProcessor

Parameters:

request -

response -

getExecObject

public ExecutionObject getExecObject()
                              throws WTException

Returns the execution object which is the target of this processor.

Supported API: false

Returns:

ExecutionObject

Throws:

WTException

getExecObjectType

public void getExecObjectType(Properties params,
                              Locale locale,
                              OutputStream os)
                       throws WTException

Returns localized string describing type of execution object, whether a project, an activity, a milestone or a deliverable.

Supported API: false

Parameters:

params -

locale -

os -

Throws:

WTException

getExecObjectName

public void getExecObjectName(Properties params,
                              Locale locale,
                              OutputStream os)
                       throws WTException

Returns the execution object's name.

Supported API: false

Parameters:

params -

locale -

os -

Throws:

WTException

getDeadline

public void getDeadline(Properties params,
                        Locale locale,
                        OutputStream os)
                 throws WTException

Returns localized string containing time of the occurrence of the deadline event.

Supported API: false

Parameters:

params -

locale -

os -

Throws:

WTException

getNewState

public void getNewState(Properties params,
                        Locale locale,
                        OutputStream os)
                 throws WTException

Returns localized string containing the name of the new state of a state transition.

Supported API: false

Parameters:

params -

locale -

os -

Throws:

WTException

getNewStatus

public void getNewStatus(Properties params,
                         Locale locale,
                         OutputStream os)
                  throws WTException

Returns localized string containing the name of the new execution status of a deliverable, project or activity.

Supported API: false

Parameters:

params -

locale -

os -

Throws:

WTException

getNewPercentComplete

public void getNewPercentComplete(Properties params,
                                  Locale locale,
                                  OutputStream os)
                           throws WTException

Returns localized string containing the name of the new completion percentage of a deliverable, project or activity.

Supported API: false

Parameters:

params -

locale -

os -

Throws:

WTException

getNewEstimatedFinish

public void getNewEstimatedFinish(Properties params,
                                  Locale locale,
                                  OutputStream os)
                           throws WTException

Returns localized string containing the name of the new estimated finish of a deliverable, project or activity.

Supported API: false

Parameters:

params -

locale -

os -

Throws:

WTException

getNewOwner

public void getNewOwner(Properties params,
                        Locale locale,
                        OutputStream os)
                 throws WTException

Returns the name of the new owner.

Supported API: false

Parameters:

params -

locale -

os -

Throws:

WTException

unsubscribe

public void unsubscribe(Properties params,
                        Locale locale,
                        OutputStream os)

Generates unsubscription URL.

Supported API: false

Parameters:

params -

locale -

os -

projectLinkAttributes

public void projectLinkAttributes(Properties params,
                                  Locale locale,
                                  OutputStream os)
                           throws WTException

Supported API: false

Parameters:

params -

locale -

os -

Throws:

WTException

removeEnclosingQuotes

protected String removeEnclosingQuotes(String value)

Utility method to remove any enclosing quotes from the given String.

Parameters:

value - the String from which to remove quotes

Returns:

the String with any enclosing quotes removed.

getFormattedTimestamp

private String getFormattedTimestamp(Timestamp timestamp,
                                     Locale locale)

Utility method to remove any enclosing quotes from the given String.

Returns:

the String with any enclosing quotes removed.

getType

private String getType(ObjectIdentifier obj_id)

getObjectName

public void getObjectName(Properties params,
                          Locale locale,
                          OutputStream os)
                   throws WTException

Throws:

WTException

getOid

private ObjectIdentifier getOid(Object obj)