Package com.ptc.core.HTMLtemplateutil.server.processors

Class UtilProcessorService

java.lang.Object
com.ptc.core.HTMLtemplateutil.server.processors.UtilProcessorService
All Implemented Interfaces:
Externalizable, Serializable, ContextHolder, ProcessorService
public class UtilProcessorService extends Object implements ProcessorService, Externalizable
Deprecated.
General purpose template processor methods available for all applications

Supported API: true

Extendable: false
See Also:

  • Method Details

    • getButton

      public void getButton(Properties parameters, Locale locale, OutputStream os)
      Deprecated.
      This Windchill script call places a "pseudo" button into an HTML template. The pseudo button contains a link within a button image.

      Supported API: true
      Parameters:
      parameters - name/value pairs passed by the script call
      • The name "resourceClass" should be used to pass the resource bundle class for the label. Optional. E.g., resourceClass=wt.part.partResource.
      • The name "resourceKey" should be used to pass the key within the bundle for the label string Optional. E.g., resourceKey=GENERATE_REPORT_BUTTON_LABEL
      • The name "buttonImg" should be used to pass the name of an image to use for the link. Optional. The image is assumed to reside in the solutions image directory identified by the wt.property "solutions.images.directory." E.g., buttonImg=iconDocGear.gif
      • The name "buttonGWMethod" should be used to pass the name of the URLProcessor method that should be used in the link URL. Optional. This will likely be either "URLTemplateAction", "generateForm", or "processForm". Optional. If not specified, "URLTemplateAction" will be used.
      • The name "buttonAction" should be used to pass the name of the action to be inserted into the query string of the URL. Optional. If not specified, "ObjProps" will be used. Ex: buttonAction=CreatePart
      • The name "buttonOID" should be used to pass the oid of the object to be inserted into the query string of the URL. Optional. If not specified, the current context object will be used.
      • The name "buttonClass" should be used to pass the object class to be inserted into the query string of the URL. Optional. Ex: buttonClass=wt.doc.WTDocument
      • The name "buttonURL" should be used to pass the fully qualified URL for the button link. Optional.
      • The name "buttonLinkTarget" should be used to pass the target for the button link. Optional. E.g., buttonLinkTarget=CreateWindow
      • The name "buttonLinkEvent" should be used to pass an event for which the button link should listen. Optional. E.g., buttonLinkEvent=onClick
      • The name "buttonLinkEventHandler" should be used to pass the method that to be called for the event passed in buttonLinkEvent. Required if buttonLinkEvent is specified. E.g., buttonLinkEventHandler=submitForm (where submitForm is the name of a javascript method)
      • The name "disableAfterClicked" should be set to "true" to disable the button after it is clicked. Optional. Typically usage is to avoid multiple clicks of a 'submit' button. Do not use this parameter if "buttonURL" is not a JavaScript call.
      • The name "enablerCallback" can be used in pair with "disableAfterClicked" to dynamically generate a JavaScipt callback fuction, which when invoked can enable the link. Developer can call the function inside function pointed to by "buttonURL", to enable the link if required.

      If buttonURL is not specified, the URL will be constructed from buttonGWMethod, buttonAction, and buttonClass or buttonOID, using the default values for those parameters if not specified.
      locale -
      os -

    • getButtonLink

      public void getButtonLink(Properties parameters, Locale locale, OutputStream os) throws WTException
      Deprecated.
      This Windchill script call generates a URL for a link within a button. It is called by the standard button subtemplate and will not typically be used by clients directly. Clients should pass the information for the URL to the processor via the call to the "getButton()" script method.

      Supported API: true
      Parameters:
      parameters -
      locale -
      os -
      Throws:
      WTException

    • getButtonLinkLabel

      public void getButtonLinkLabel(Properties parameters, Locale locale, OutputStream os) throws WTException
      Deprecated.
      This Windchill script method generates the label for a link within a button. It is called by the standard button subtemplate and will not typically be used by clients directly. Clients should pass the information for the label to the processor via the call to the "getButton()" script method.

      Supported API: true
      Parameters:
      parameters - name/value pairs passed via the script call. None are recognized by this method.
      locale -
      os -
      Throws:
      WTException

    • getButtonLinkTarget

      public void getButtonLinkTarget(Properties parameters, Locale locale, OutputStream os)
      Deprecated.
      This Windchill script method generates a target attribute for the link within a button. It is called by the standard button subtemplate and will not typically be used by clients directly. Clients should pass the target to the processor via the call to the "getButton()" script method. Ex output: target="CreateWindow"

      Supported API: true
      Parameters:
      parameters - name/value pairs passed by the script call. None are recognized by this method.
      locale - the locale to use for localization
      os - the output stream

    • getCSSLink

      public void getCSSLink(Properties parameters, Locale locale, OutputStream os) throws WTException
      Deprecated.
      This Windchill script method generates a style sheet link in the HTML page. It should be called within the HEAD section of the page.

      Supported API: true
      Parameters:
      parameters - optional name/value pairs passed by the script call
      • The name "resourceName" can be used to pass the URL for the HREF attribute. E.g., resourceName=com/ptc/windchill/pdmlink/myStyleSheet.css. If not specified, the default PDMLink style sheet will be used.
      locale - the locale to use for localization
      os - the output stream
      Throws:
      WTException

    • getBodyTag

      public void getBodyTag(Properties parameters, Locale locale, OutputStream os)
      Deprecated.
      This Windchill script method generates a body tag on the HTML page.

      Supported API: true
      Parameters:
      parameters - optional name/value pairs passed by the script call
      • The name "styleClass" can be used to pass the name of the style class to be used for the body tag. E.g., styleClass=myBodyClass. If not specified, the default body style class from the style sheet file will be used.
      locale - the locale to use for localization
      os - the output stream

    • getJsIncludes

      public void getJsIncludes(Properties parameters, Locale locale, OutputStream os)
      Deprecated.
      This Windchill script method just includes Javascript.html in the page. While using this script call, make sure that to pass includeJavascriptTemplate false param value while making getBodyTag() script call. This will ensure that Javascript.html includes don't happen twice.

      Supported API: true
      Parameters:
      parameters - optional name/value pairs passed by the script call
      locale - the locale to use for localization
      os - the output stream

    • getBaseTag

      public void getBaseTag(Properties parameters, Locale locale, OutputStream os) throws WTException
      Deprecated.
      This Windchill script method generates a base tag in the HTML page. It should be called at the beginning of the HEAD section of the page.

      Supported API: true
      Parameters:
      parameters - optional name/value pairs passed by the script call
      • The name "resourceName" can be used to pass the path of the base relative to Windchill/codebase. E.g., resourceName=wt/images. If not specified, Windchill/codebase will be used as the base.
      locale - locale to use for localization
      os - the output stream
      Throws:
      WTException

    • getState

      public HTTPState getState()
      Deprecated.
      Gets the object for the association that plays role: theState.

      Supported API: true
      Specified by:
      getState in interface ProcessorService
      Returns:
      HTTPState

    • setState

      public void setState(HTTPState a_State)
      Deprecated.
      Sets the object for the association that plays role: theState.

      Supported API: true
      Specified by:
      setState in interface ProcessorService
      Parameters:
      a_State -

    • getContextAction

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

      Supported API: true
      Specified by:
      getContextAction in interface ContextHolder
      Returns:
      String

    • setContextAction

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

      Supported API: true
      Specified by:
      setContextAction in interface ContextHolder
      Parameters:
      a_ContextAction -

    • getContextObj

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

      Supported API: true
      Specified by:
      getContextObj in interface ContextHolder
      Returns:
      Object

    • setContextObj

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

      Supported API: true
      Specified by:
      setContextObj in interface ContextHolder
      Parameters:
      a_ContextObj -

    • getContextClassName

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

      Supported API: true
      Specified by:
      getContextClassName in interface ContextHolder
      Returns:
      String

    • setContextClassName

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

      Supported API: true
      Specified by:
      setContextClassName in interface ContextHolder
      Parameters:
      a_ContextClassName -

    • getContextProperties

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

      Supported API: true
      Specified by:
      getContextProperties in interface ContextHolder
      Returns:
      Properties

    • setContextProperties

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

      Supported API: true
      Specified by:
      setContextProperties in interface ContextHolder
      Parameters:
      a_ContextProperties -

    • getResponseExceptions

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

      Supported API: true
      Specified by:
      getResponseExceptions in interface ContextHolder
      Returns:
      Vector

    • setResponseExceptions

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

      Supported API: true
      Specified by:
      setResponseExceptions in interface ContextHolder
      Parameters:
      a_ResponseExceptions -

    • getResponseFooters

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

      Supported API: true
      Specified by:
      getResponseFooters in interface ContextHolder
      Returns:
      Vector

    • setResponseFooters

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

      Supported API: true
      Specified by:
      setResponseFooters in interface ContextHolder
      Parameters:
      a_ResponseFooters -

    • getResponseHeaders

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

      Supported API: true
      Specified by:
      getResponseHeaders in interface ContextHolder
      Returns:
      Vector

    • setResponseHeaders

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

      Supported API: true
      Specified by:
      setResponseHeaders in interface ContextHolder
      Parameters:
      a_ResponseHeaders -

    • getResponseMessages

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

      Supported API: true
      Specified by:
      getResponseMessages in interface ContextHolder
      Returns:
      Vector

    • setResponseMessages

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

      Supported API: true
      Specified by:
      setResponseMessages in interface ContextHolder
      Parameters:
      a_ResponseMessages -

    • getResponseString

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

      Supported API: true
      Specified by:
      getResponseString in interface ContextHolder
      Returns:
      String

    • setResponseString

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

      Supported API: true
      Specified by:
      setResponseString in interface ContextHolder
      Parameters:
      a_ResponseString -

    • getStatus

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

      Supported API: true
      Specified by:
      getStatus in interface ContextHolder
      Returns:
      int

    • setStatus

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

      Supported API: true
      Specified by:
      setStatus in interface ContextHolder
      Parameters:
      a_Status -

    • getFormData

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

      Supported API: true
      Specified by:
      getFormData in interface ContextHolder
      Returns:
      Properties

    • setFormData

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

      Supported API: true
      Specified by:
      setFormData in interface ContextHolder
      Parameters:
      a_FormData -

    • getQueryData

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

      Supported API: true
      Specified by:
      getQueryData in interface ContextHolder
      Returns:
      Properties

    • setQueryData

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

      Supported API: true
      Specified by:
      setQueryData in interface ContextHolder
      Parameters:
      a_QueryData -

    • addToResponseExceptions

      public 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

      Specified by:
      addToResponseExceptions in interface ContextHolder
      Parameters:
      newException -

    • addToResponseMessages

      public 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

      Specified by:
      addToResponseMessages in interface ContextHolder
      Parameters:
      newMessage -

    • addToResponseHeaders

      public 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

      Specified by:
      addToResponseHeaders in interface ContextHolder
      Parameters:
      newHeader -

    • addToResponseFooters

      public 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

      Specified by:
      addToResponseFooters in interface ContextHolder
      Parameters:
      newFooter -