wt.eff
Class SetEffFormProcessor

java.lang.Object
  wt.enterprise.BasicTemplateProcessor
      wt.templateutil.processor.DefaultTemplateProcessor
          wt.templateutil.processor.GenerateFormProcessor
              wt.eff.AddEffFormProcessor
                  wt.eff.SetEffFormProcessor

All Implemented Interfaces:

ContextHolder, ContextTranslator, Evolvable, Externalizable, Serializable, TemplateProcessor

public class SetEffFormProcessor

extends AddEffFormProcessor

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
protected static String	DEFAULT_FORM_ACTION
static String	DELETE_CHECKBOX_NAME
static String	EFF_GROUP_NAME
static long	EXTERNALIZATION_VERSION_UID
static String	NEW_VALUE_TEXTFIELD_NAME
static String	NO_CONTEXT
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
static String	SEPARATOR
(package private) static long	serialVersionUID

Fields inherited from class wt.eff.AddEffFormProcessor

AUTHORIZED_BY, CONFIG_NAME_VARIABLE_NAME, DEFAULT_FORM_METHOD, DEFAULT_FORM_NAME, DEFAULT_PROCESS_METHOD, DEFAULT_VALIDATE_FUNCTION_NAME, EFF_TYPE_SELECT_NAME, EFF_TYPE_VARIABLE_NAME, EFF_VALUE_VARIABLE_NAME, effContext, OBJREF_VARIABLE_NAME, SEARCH_RESULT_OBJREF, VERBOSE

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

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

SetEffFormProcessor()

Method Summary

void	buildSearchURL(Properties properties, Locale locale, OutputStream os) Builds a URL to search using the ObjectSearchProcessor Supported API: false
static String	convertEffGroupToString(EffGroup eff_group) Output a String representation of the given EffGroup.
static EffGroup	convertStringToEffGroup(String eff_string) Converts the given String into an EffGroup object.
protected String	getFormValue(String property) Checks the FormData for this template processor for a value corresponding to the given String property.
void	outputExistingEff(Properties props, Locale locale, OutputStream os) Outputs a table of the effectivities currently associated with the context object.
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(SetEffFormProcessor thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	startForm(Properties props, Locale locale, OutputStream os) Outputs the FORM tag for starting an HTML FORM.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class wt.eff.AddEffFormProcessor

addFontTags, buildSearchURL, copyProperties, endForm, getContextEffContext, getContextEffManagedVersion, getCurrentPageURL, getEffContextByName, getEffGroupPairs, getHiddenFieldHTML, outputConfigItemVariableName, outputEffContextDisplayIdentity, outputEffContextObjRef, outputEffectivityType, outputEffectivityValue, outputFormName, outputHiddenField, outputObjRefVariableName, outputSubmitButton, outputTypeVariableName, outputValueVariableName, readVersion, startForm

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

NEW_VALUE_TEXTFIELD_NAME

public static String NEW_VALUE_TEXTFIELD_NAME

DELETE_CHECKBOX_NAME

public static String DELETE_CHECKBOX_NAME

EFF_GROUP_NAME

public static String EFF_GROUP_NAME

SEPARATOR

public static String SEPARATOR

NO_CONTEXT

public static String NO_CONTEXT

DEFAULT_FORM_ACTION

protected static String DEFAULT_FORM_ACTION

Constructor Detail

SetEffFormProcessor

public SetEffFormProcessor()

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 AddEffFormProcessor

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 AddEffFormProcessor

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

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

outputExistingEff

public void outputExistingEff(Properties props,
                              Locale locale,
                              OutputStream os)
                       throws WTException

Outputs a table of the effectivities currently associated with the context object. The table is output as modifyable - entries can be deleted and ranges can be modified.

Throws:

WTException

getFormValue

protected String getFormValue(String property)

Checks the FormData for this template processor for a value corresponding to the given String property. This method is useful for redisplaying a form in which values have already been entered.

Parameters:

property - the String property whose value is returned

Returns:

the String value of the given property taken from the form data for this template processor. If no such value exists in the form data, null is returned.

convertEffGroupToString

public static String convertEffGroupToString(EffGroup eff_group)
                                      throws WTException

Output a String representation of the given EffGroup. This string representation is used as the value of a hidden field to maintain information about the given EffGroup in a form processor.

Parameters:

eff_group - the EffGroup for which a string representation is returned

Returns:

a string representation used for a hidden field.

Throws:

WTException

convertStringToEffGroup

public static EffGroup convertStringToEffGroup(String eff_string)
                                        throws WTException

Converts the given String into an EffGroup object.

Throws:

WTException

startForm

public void startForm(Properties props,
                      Locale locale,
                      OutputStream os)
               throws WTException

Outputs the FORM tag for starting an HTML FORM. If a value for the key, "context_action", has been given in the given Properties object, this method will only output the form if the given action matches the context action. This method allows HTML templates containing form elements to be used within a larger form.

Overrides:

startForm in class AddEffFormProcessor

Parameters:

props - the Properties object containing parameters passed in the SCRIPT call

locale - the Locale of the client

os - the OutputStream to write the FORM to

Throws:

WTException

buildSearchURL

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

Builds a URL to search using the ObjectSearchProcessor

Supported API: false

Overrides:

buildSearchURL in class AddEffFormProcessor

Parameters:

properties -

locale -

os -

Throws:

WTException