wt.templateutil.processor
Interface ProcessorService

All Superinterfaces:

ContextHolder

All Known Implementing Classes:

AbstractProcessorService, CADDocBaselineTemplateProcessor, CADDocProcessorService, ClientActionProcessService, CommonProcessorService, ContainerTemplateProcessor, DateProcessor, EPMProcessorService, JSCommonService, LifeCycleProcessorService, LinkProcessorService, PickerBrowserProcessor, PickerFormProcessor, PickerSearcherProcessor, ProjectlinkUtilProcessorService, RedirectPageProcessor, RoleHolderProcessorService, RulesCollectionSectionProcessor, RulesConfigurationSectionProcessor, RulesDependencyProcessor, RulesJavaScriptProcessor, RulesSectionProcessor, ServletSessionCookieProcessorService, StateProcessorService, SubTemplateService, TeamRoleHolderProcessorService, TemplateProcessorTableService, TypeInstanceAttributesService, UtilProcessorService, WorkProcessorService, WorkspaceCommonTemplateProcessor, WsPrefCommonTemplateProcessor

public interface ProcessorService

extends ContextHolder

Deprecation Notice: This class is still valid for this release, however this serves as advance notice that it will be removed in the future. All user interfaces built using the Windchill HTML Template Processing client architecture will be rewritten using a different framework in an upcoming release. ProcessorService defines the interface that a "state" based service to a TemplateProcessor subclass should implement. A implementor of this interface will be able accept the HTTPState object of the current TemplateProcessor and perform some service with access to the current "state" as represented in in the HTTPState object.

In many cases there is a some common service that is required by several TemplateProcessors. One could place the code in the common parent of the TemplateProcessors to make the code available to all of the TemplateProcessors or place redundent code in all of the TemplateProcessors.

Neither of these is desirable. The better solution is to create an implementor of this interface an have the implementor of this interface perform the service. This implements a more correct Object Orient code solution.

Here is how to access your new Service and a specific method in your new service Assume that the class, wt.util.MyTemplateService, is an implementor of the ProcessorService and that the method displayHelpIcon has the correct signature for a Windchill script call, namely,

public void displayHelpIcon(Properties parameters, Locale locale, OutputStream os)

Use the following winchill Script call to invoke this method

useProcessorService service=wt.util.MyTemplateService method=displayHelpIcon

Implementors of this interface MUST be modeled and be code generated. If they are not, then the required methods and default implementations will not be present.

Supported API: true

Extendable: true

Field Summary

static String

STATE Deprecated.

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

Method Summary

HTTPState	getState() Deprecated.
void	setState(HTTPState a_State) Deprecated.

Methods inherited from interface wt.templateutil.processor.ContextHolder

addToResponseExceptions, addToResponseFooters, addToResponseHeaders, addToResponseMessages, getContextAction, getContextClassName, getContextObj, getContextProperties, getFormData, getQueryData, getResponseExceptions, getResponseFooters, getResponseHeaders, getResponseMessages, getResponseString, getStatus, setContextAction, setContextClassName, setContextObj, setContextProperties, setFormData, setQueryData, setResponseExceptions, setResponseFooters, setResponseHeaders, setResponseMessages, setResponseString, setStatus

Field Detail

STATE

public static final String STATE

Deprecated.

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getState

public HTTPState getState()

Deprecated.

Gets the object for the association that plays role: STATE.

Supported API: true

Returns:

HTTPState

setState

public void setState(HTTPState a_State)

Deprecated.

Sets the object for the association that plays role: STATE.

Supported API: true

Parameters:

a_State -