Package com.webmethods.portal.framework.presentation

Interface IPresentationData

All Known Implementing Classes:
PresentationData
public interface IPresentationData

  • Field Details

  • Method Details

    • init

      IPresentationData init(Object dataObject, int dataType, HashMap<Object,Object> attributes)
      Initializes this.
      Parameters:
      dataObject - Object to be presented.
      dataType - Type of object to be presented.
      attributes - (optional) Map of attributes associated with the presentation.

    • getDataObject

      Object getDataObject()
      The primary object representing the requested resource. Of type specified by getDataType().
      Returns:
      Data object or null.
      See Also:

    • setDataObject

      void setDataObject(Object obj)
      The primary object representing the requested resource. Of type specified by setDataType(int).
      Parameters:
      obj - Data object or null.
      See Also:

    • getDataType

      int getDataType()
      Type of the principal object in this presentation cycle.
      Returns:
      Either:
      See Also:

    • setDataType

      void setDataType(int dataType)
      Type of the principal object in this presentation cycle.
      Parameters:
      dataType - Either:
      See Also:

    • clone

      Object clone()
      Creates a shallow copy of this.
      Returns:
      Shallow copy of this.
      See Also:

    • putAll

      void putAll(Map<?,?> t)
      Copies all of the mappings from the specified map to this map These mappings will replace any mappings that this map had for any of the keys currently in the specified map.
      Parameters:
      t - mappings to be stored in this map.
      Throws:
      NullPointerException - if the specified map is null.
      See Also:

    • getLayout

      String getLayout()
      Name of top-level JSP layout file used for presentation, such as '/ui/samplejsp/datatest' or 'default'. May be null.
      Returns:
      JSP layout name or null.

    • setLayout

      void setLayout(String layout)
      Name of top-level JSP layout file used for presentation, such as '/ui/samplejsp/datatest' or 'default'. May be null.
      Parameters:
      layout - JSP layout name or null.

    • getErrorLayout

      String getErrorLayout()
      Name of the top-level JSP layout file used if an error occurs handling the request. May be null.
      Returns:
      JSP layout name or null.
      See Also:

    • setErrorLayout

      void setErrorLayout(String errorLayout)
      Name of the top-level JSP layout file used if an error occurs handling the request. May be null.
      Parameters:
      errorLayout - JSP layout name or null.

    • getDefaultLayout

      String getDefaultLayout()
      Deprecated.
      Name of default top-level JSP layout file for this data object type, such as 'folder' or 'default'. May be null.
      Returns:
      JSP layout name or null.
      See Also:

    • setDefaultLayout

      void setDefaultLayout(String defaultLayout)
      Deprecated.
      Name of default top-level JSP layout file for this data object type, such as 'folder' or 'default'. May be null.
      Parameters:
      defaultLayout - JSP layout name or null.

    • getResource

      String getResource()
      Deprecated.
      Full file-path of top-level JSP layout file used for presentation, such as '/ui/samplejsp/datatest.jsp' or '/ui/app/default.jsp'.
      Returns:
      Full JSP layout name.
      See Also:

    • setResource

      void setResource(String resource)
      Deprecated.
      Full file-path of top-level JSP layout file used for presentation, such as '/ui/samplejsp/datatest.jsp' or '/ui/app/default.jsp'.
      Parameters:
      resource - Full JSP layout name.

    • getExtension

      String getExtension()
      Name of top-level JSP layout file used for presentation, such as 'jsp'. May be null.
      Returns:
      File extension.
      See Also:

    • setExtension

      void setExtension(String extension)
      Name of top-level JSP layout file used for presentation, such as 'jsp'. May be null.
      Parameters:
      extension - File extension.

    • getBaseResource

      String getBaseResource()
      Deprecated.
      '/ui/app'

    • setBaseResource

      void setBaseResource(String baseResource)
      Deprecated.
      '/ui/app'

    • getHelp

      String getHelp()
      Base help web-path, such as '/ui/help/'.
      Returns:
      Base help web-path.

    • setHelp

      void setHelp(String help)
      Base help web-path, such as '/ui/help/'.
      Parameters:
      help - Base help web-path.

    • getContextPath

      String getContextPath()
      Web context path. Never null or empty. Always starts with a leading slash; never ends with a trailing slash -- unless the entire context path is simply '/'.
      Returns:
      Web context path.
      See Also:

    • setContextPath

      void setContextPath(String contextPath)
      Web context path. Never null or empty. Always starts with a leading slash; never ends with a trailing slash -- unless the entire context path is simply '/'.
      Parameters:
      contextPath - Web context path.
      See Also:

    • getServletPath

      String getServletPath()
      Servlet path. Never null; may be empty. Always starts with a leading slash -- unless the path is the empty string (""); never ends with a trailing slash.
      Returns:
      Servlet path.
      See Also:

    • setServletPath

      void setServletPath(String servletPath)
      Servlet path. Never null; may be empty. Always starts with a leading slash -- unless the path is the empty string (""); never ends with a trailing slash.
      Parameters:
      servletPath - Servlet path.
      See Also:

    • getFullServletPath

      String getFullServletPath()
      Web context path plus servlet path plus trailing slash. Never null or empty. Always starts with a leading-slash; always ends with a trailing slash.
      Returns:
      Full servlet path.

    • getCanonicalServletPath

      String getCanonicalServletPath()
      Web context path plus servlet path minus trailing slash. Never null; may be empty. Always starts with a leading slash; never ends with a trailing slash.
      Returns:
      Canonical servlet path.

    • getResourceID

      String getResourceID()
      If this data object is an addressable portal object, its addressable ID as a String; otherwise, null.
      Returns:
      Resource ID or null.

    • getResourceURI

      IURI getResourceURI()
      If this data object is an addressable portal object, its addressable ID as a portal IURI; otherwise, null.
      Returns:
      Resource ID or null.

    • setResourceURI

      void setResourceURI(IURI resourceURI)
      If this data object is an addressable portal object, its addressable ID as a portal IURI; otherwise, null.
      Parameters:
      resourceURI - Resource ID or null.

    • getContext

      Object getContext()
      Current JSP PageContext.
      Returns:
      JSP page context.

    • setContext

      void setContext(Object context)
      Current JSP PageContext.
      Parameters:
      context - JSP page context.

    • getRelativeTheme

      String getRelativeTheme()
      Deprecated.
      '/ui/'

    • setRelativeTheme

      void setRelativeTheme(String relativeTheme)
      Deprecated.
      '/ui/'

    • getApplication

      String getApplication()
      Deprecated.
      '/ui/app/'

    • setApplication

      void setApplication(String applicationPath)
      Deprecated.
      '/ui/app/'

    • getScripts

      String getScripts()
      Deprecated.
      '/ui/scripts/'

    • setScripts

      void setScripts(String scriptsPath)
      Deprecated.
      '/ui/scripts/'

    • getCss

      String getCss()
      Deprecated.
      '/ui/css/'

    • setCss

      void setCss(String cssPath)
      Deprecated.
      '/ui/css/'

    • getStyle

      String getStyle()
      Deprecated.
      web-path to skin folder '/ui/skins/wm_skin_modern/'

    • getShell

      IThingID getShell()
      Deprecated.
      hack for test-auto current shell id

    • setStyle

      void setStyle(String style)
      Deprecated.
      web-path to skin folder '/ui/skins/wm_skin_modern/'

    • getXslt

      String getXslt()
      Deprecated.
      '/ui/xslt/'

    • setXslt

      void setXslt(String xsltPath)
      Deprecated.
      '/ui/xslt/'

    • getImages

      String getImages()
      Standard-images web-path: '/ui/images/'. Never null or empty. Always begins with a leading slash and ends with a trailing slash.
      Returns:
      Standard images web-path.

    • setImages

      void setImages(String images)
      Standard-images web-path: '/ui/images/'. Never null or empty. Always begins with a leading slash and ends with a trailing slash.
      Parameters:
      images - Standard images web-path.

    • getEditor

      String getEditor()
      Deprecated.
      '/ui/editor/'

    • setEditor

      void setEditor(String editorPath)
      Deprecated.
      '/ui/editor/'

    • getWidgets

      String getWidgets()
      Deprecated.
      '/ui/portlets/'

    • setWidgets

      void setWidgets(String widgetsPath)
      Deprecated.
      '/ui/portlets/'

    • getPortlet

      String getPortlet()
      Deprecated.
      '/ui/portlets/wm_active_portlet'

    • setPortlet

      void setPortlet(String portletPath)
      Deprecated.
      '/ui/portlets/wm_active_portlet'

    • getWorkspaces

      String getWorkspaces()
      Deprecated.
      '/ui/workspaces/'

    • setWorkspaces

      void setWorkspaces(String workSpacesPath)
      Deprecated.
      '/ui/workspaces/'

    • getIncludes

      String getIncludes()
      Deprecated.
      '/ui/include/'

    • setIncludes

      void setIncludes(String includesPath)
      Deprecated.
      '/ui/include/'

    • getLoginName

      String getLoginName()
      Deprecated.
      use IContext.

    • setLoginName

      void setLoginName(String loginName)
      Deprecated.
      use IContext.

    • getMimeType

      String getMimeType()
      Media type of presentation, such as 'text/html'.
      Returns:
      Media type.

    • setMimeType

      void setMimeType(String mimeType)
      Media type of presentation, such as 'text/html'.
      Parameters:
      mimeType - Media type.

    • getServerURL

      String getServerURL()
      Configured cluster server URL, such as 'http://www.webmethods.com:8080'. Never empty or null. Never ends with trailing slash.
      Returns:
      Configured cluster server URL.

    • setServerURL

      void setServerURL(String serverURL)
      SConfigured cluster server URL, such as 'http://www.webmethods.com:8080'. Never empty or null. Never ends with trailing slash.
      Parameters:
      serverURL - Configured cluster server URL.

    • getRequestedServerURL

      String getRequestedServerURL()
      Actual server URL specified by client request, such as 'http://portal.webmethods.com:8080'. Never empty or null. Never ends with trailing slash.
      Returns:
      Actual server URL.

    • setRequestedServerURL

      void setRequestedServerURL(String serverURL)
      Actual server URL specified by client request, such as 'http://portal.webmethods.com:8080'. Never empty or null. Never ends with trailing slash.
      Parameters:
      serverURL - Actual server URL.

    • getCurrentRequestURL

      String getCurrentRequestURL()
      Full path plus query string of current request, such as '/meta/default/folder/0000001241?layout=properties'. Never null, may be empty. If not empty, always begins with a leading slash.
      Returns:
      Full path plus query string of current request.

    • setCurrentRequestURL

      void setCurrentRequestURL(String url)
      Full path plus query string of current request, such as '/meta/default/folder/0000001241?layout=properties'. Never null, may be empty. If not empty, always begins with a leading slash.
      Parameters:
      url - Full path plus query string of current request.

    • getPreviousRequestURL

      String getPreviousRequestURL()
      Full path plus query string of previous request in the current session, such as '/meta/default/folder/0000001241?layout=wiring'. Null if this is the first request in the current session; may be empty. If not empty, always begins with a leading slash.
      Returns:
      Full path plus query string of previous request in the current session.

    • setPreviousRequestURL

      void setPreviousRequestURL(String url)
      Full path plus query string of previous request in the current session, such as '/meta/default/folder/0000001241?layout=wiring'. Null if this is the first request in the current session; may be empty. If not empty, always begins with a leading slash.
      Parameters:
      url - Full path plus query string of previous request in the current session.

    • getBuildVersion

      String getBuildVersion()
      Portal build version string, such as '6.0.1.1.172'.
      Returns:
      Portal build version string.

    • getSystemTitle

      String getSystemTitle() throws PortalException
      Portal system title, such as 'webMethods Portal'. This property can be configured the portal resource whose alias is 'system.title'
      Returns:
      Portal system title.
      Throws:
      PortalException

    • release

      void release()
      Deprecated.
      Cleans up this object's member resources, preparing it to be added back into the pool. This method should be called prior to checking this object back into the pool.
      See Also:

    • getPool

      IObjectPool<? extends IPresentationData> getPool()
      Deprecated.
      Gets this object's pool. May return null.
      See Also:

    • setPool

      void setPool(IObjectPool<? extends IPresentationData> pool)
      Deprecated.
      Sets this object's pool. Implementing classes may choose not to allow this object's pool to be set. In that case, setPool(com.webmethods.portal.system.pool.IObjectPool<? extends com.webmethods.portal.framework.presentation.IPresentationData>) does nothing.
      See Also: