Package wt.templateutil.processor

Interface ContextHolder

All Known Subinterfaces:
ProcessorService
All Known Implementing Classes:
AbstractHTMLTemplateFactory, BasicTemplateProcessor, CheckoutDownloadDelegateToOtherActions, ClientActionProcessService, ContainerTemplateProcessor, CreateWTDocumentTaskDelegate, DefaultHTMLTemplateFactory, DefaultTemplateProcessor, EditSecurityLabelsToolbarProcessor, ErrorProcessor, ExpandCollapseSectionProcessor, com.ptc.core.htmlcomp.exttp.ExtJSTToolBar2Processor, com.ptc.core.htmlcomp.exttp.ExtJSTToolBarProcessor, FormTaskDelegate, GenerateFormProcessor, GenWsprefFormTaskDelegate, com.ptc.windchill.cadx.common.HelpGenerationProcessor, wt.templateutil.processor.HelpHTMLTemplateFactory, HTTPState, IBADisplayUnitsFormTaskDelegate, LifeCycleProcessorService, LinkProcessorService, NavigateFoldersTaskDelegate, NavigateFormProcessor, com.ptc.core.htmlcomp.util.NonTableHelpGenerationProcessor, ObjectPropertiesTableProcessor, PartReferencesProcessor, PartReplacementsProcessor, PickerFormProcessor, PlmConfigurationsProcessor, ProductInstancesProcessor, RedirectPageProcessor, ReferencedByProcessor, RoleHolderProcessorService, StateProcessorService, SubTemplateService, TeamRoleHolderProcessorService, TemplateProcessorTableService, TutorialTemplateFactory, com.ptc.core.htmlcomp.collection.presentation.UIExtCollectionTableToolbarProcessor, UtilProcessorService, VersionHistoryProcessor, WorkProcessorService, WsPrefCommonTemplateProcessor, WTDocumentTemplateFormTaskDelegate
public interface ContextHolder
Deprecated.
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. This class represents the interface all classes that want to have some concept of "State" relative Template Processing need to implement. an class that implements this interface will be conversive with an an HTTPState object that is used to encapsulate the current "state" of a template processing session.
The most common way to implement this interface is to have an aggregated instance of an HTTPState object and then have all of methods in this interface actually proxy for the HTTPState object. Then, if you would like to pass off the current state, you only need to pass off the aggregated HTTPState object.


Supported API: true

Extendable: false

  • Field Details

    • CONTEXT_ACTION

      static final String CONTEXT_ACTION
      Deprecated.
      Label for the attribute; Context Action is the name of the action of the current page

      Supported API: true
      See Also:

    • CONTEXT_OBJ

      static final String CONTEXT_OBJ
      Deprecated.
      Label for the attribute; Context Object is the reference object of the current page

      Supported API: true
      See Also:

    • CONTEXT_CLASS_NAME

      static final String CONTEXT_CLASS_NAME
      Deprecated.
      Label for the attribute; Context Object Name is the name of the class of the current page

      Supported API: true
      See Also:

    • CONTEXT_PROPERTIES

      static final String CONTEXT_PROPERTIES
      Deprecated.
      Label for the attribute.

      Supported API: true
      See Also:

    • RESPONSE_EXCEPTIONS

      static final String RESPONSE_EXCEPTIONS
      Deprecated.
      Label for the attribute.

      Supported API: true
      See Also:

    • RESPONSE_FOOTERS

      static final String RESPONSE_FOOTERS
      Deprecated.
      Label for the attribute.

      Supported API: true
      See Also:

    • RESPONSE_HEADERS

      static final String RESPONSE_HEADERS
      Deprecated.
      Label for the attribute.

      Supported API: true
      See Also:

    • RESPONSE_MESSAGES

      static final String RESPONSE_MESSAGES
      Deprecated.
      Label for the attribute.

      Supported API: true
      See Also:

    • RESPONSE_STRING

      static final String RESPONSE_STRING
      Deprecated.
      Label for the attribute.

      Supported API: true
      See Also:

    • STATUS

      static final String STATUS
      Deprecated.
      Label for the attribute.

      Supported API: true
      See Also:

    • FORM_DATA

      static final String FORM_DATA
      Deprecated.
      Label for the attribute; Form Data is the data present in the form of the current HTML page.

      Supported API: true
      See Also:

    • QUERY_DATA

      static final String QUERY_DATA
      Deprecated.
      Label for the attribute; Query Data is the information present after the "?" mark on the URL of the current page.

      Supported API: true
      See Also:

  • Method Details

    • getContextAction

      String getContextAction()
      Deprecated.
      Gets the value of the attribute: CONTEXT_ACTION. Context Action is the name of the action of the current page

      Supported API: true
      Returns:
      String

    • setContextAction

      void setContextAction(String a_ContextAction)
      Deprecated.
      Sets the value of the attribute: CONTEXT_ACTION. Context Action is the name of the action of the current page

      Supported API: true
      Parameters:
      a_ContextAction -

    • getContextObj

      Object getContextObj()
      Deprecated.
      Gets the value of the attribute: CONTEXT_OBJ. Context Object is the reference object of the current page

      Supported API: true
      Returns:
      Object

    • setContextObj

      void setContextObj(Object a_ContextObj)
      Deprecated.
      Sets the value of the attribute: CONTEXT_OBJ. Context Object is the reference object of the current page

      Supported API: true
      Parameters:
      a_ContextObj -

    • getContextClassName

      String getContextClassName()
      Deprecated.
      Gets the value of the attribute: CONTEXT_CLASS_NAME. Context Object Name is the name of the class of the current page

      Supported API: true
      Returns:
      String

    • setContextClassName

      void setContextClassName(String a_ContextClassName)
      Deprecated.
      Sets the value of the attribute: CONTEXT_CLASS_NAME. Context Object Name is the name of the class of the current page

      Supported API: true
      Parameters:
      a_ContextClassName -

    • getContextProperties

      Properties getContextProperties()
      Deprecated.
      Gets the value of the attribute: CONTEXT_PROPERTIES.

      Supported API: true
      Returns:
      Properties

    • setContextProperties

      void setContextProperties(Properties a_ContextProperties)
      Deprecated.
      Sets the value of the attribute: CONTEXT_PROPERTIES.

      Supported API: true
      Parameters:
      a_ContextProperties -

    • getResponseExceptions

      Vector getResponseExceptions()
      Deprecated.
      Gets the value of the attribute: RESPONSE_EXCEPTIONS.

      Supported API: true
      Returns:
      Vector

    • setResponseExceptions

      void setResponseExceptions(Vector a_ResponseExceptions)
      Deprecated.
      Sets the value of the attribute: RESPONSE_EXCEPTIONS.

      Supported API: true
      Parameters:
      a_ResponseExceptions -

    • getResponseFooters

      Vector getResponseFooters()
      Deprecated.
      Gets the value of the attribute: RESPONSE_FOOTERS.

      Supported API: true
      Returns:
      Vector

    • setResponseFooters

      void setResponseFooters(Vector a_ResponseFooters)
      Deprecated.
      Sets the value of the attribute: RESPONSE_FOOTERS.

      Supported API: true
      Parameters:
      a_ResponseFooters -

    • getResponseHeaders

      Vector getResponseHeaders()
      Deprecated.
      Gets the value of the attribute: RESPONSE_HEADERS.

      Supported API: true
      Returns:
      Vector

    • setResponseHeaders

      void setResponseHeaders(Vector a_ResponseHeaders)
      Deprecated.
      Sets the value of the attribute: RESPONSE_HEADERS.

      Supported API: true
      Parameters:
      a_ResponseHeaders -

    • getResponseMessages

      Vector getResponseMessages()
      Deprecated.
      Gets the value of the attribute: RESPONSE_MESSAGES.

      Supported API: true
      Returns:
      Vector

    • setResponseMessages

      void setResponseMessages(Vector a_ResponseMessages)
      Deprecated.
      Sets the value of the attribute: RESPONSE_MESSAGES.

      Supported API: true
      Parameters:
      a_ResponseMessages -

    • getResponseString

      String getResponseString()
      Deprecated.
      Gets the value of the attribute: RESPONSE_STRING.

      Supported API: true
      Returns:
      String

    • setResponseString

      void setResponseString(String a_ResponseString)
      Deprecated.
      Sets the value of the attribute: RESPONSE_STRING.

      Supported API: true
      Parameters:
      a_ResponseString -

    • getStatus

      int getStatus()
      Deprecated.
      Gets the value of the attribute: STATUS.

      Supported API: true
      Returns:
      int

    • setStatus

      void setStatus(int a_Status)
      Deprecated.
      Sets the value of the attribute: STATUS.

      Supported API: true
      Parameters:
      a_Status -

    • getFormData

      Properties getFormData()
      Deprecated.
      Gets the value of the attribute: FORM_DATA. Form Data is the data present in the form of the current HTML page.

      Supported API: true
      Returns:
      Properties

    • setFormData

      void setFormData(Properties a_FormData)
      Deprecated.
      Sets the value of the attribute: FORM_DATA. Form Data is the data present in the form of the current HTML page.

      Supported API: true
      Parameters:
      a_FormData -

    • getQueryData

      Properties getQueryData()
      Deprecated.
      Gets the value of the attribute: QUERY_DATA. Query Data is the information present after the "?" mark on the URL of the current page.

      Supported API: true
      Returns:
      Properties

    • setQueryData

      void setQueryData(Properties a_QueryData)
      Deprecated.
      Sets the value of the attribute: QUERY_DATA. Query Data is the information present after the "?" mark on the URL of the current page.

      Supported API: true
      Parameters:
      a_QueryData -

    • addToResponseExceptions

      void addToResponseExceptions(Exception newException)
      Deprecated.
      Adds a LocalizableMessage message to the list of stackTraces that can be presented with the Windchill Script call

      showResponseExceptions

      Supported API: true

      Parameters:
      newException -

    • addToResponseMessages

      void addToResponseMessages(LocalizableMessage newMessage)
      Deprecated.
      Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

      showResponseMessages

      Supported API: true

      Parameters:
      newMessage -

    • addToResponseHeaders

      void addToResponseHeaders(LocalizableMessage newHeader)
      Deprecated.
      Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

      showResponseHeaders

      Supported API: true

      Parameters:
      newHeader -

    • addToResponseFooters

      void addToResponseFooters(LocalizableMessage newFooter)
      Deprecated.
      Adds a LocalizableMessage message to the list of localizable messages that can be presented with the Windchill Script call

      showResponseFooters

      Supported API: true

      Parameters:
      newFooter -