public interface IPresentationData
Modifier and Type | Field and Description |
---|---|
static int |
DATA_DIRECTORY
Data object is a
com.webmethods.portal.service.directory.IDirectoryService . |
static int |
DATA_DS_PRINCIPAL
Data object is a
com.webmethods.portal.service.directory.IDirectoryPrincipal . |
static int |
DATA_EMPTY
No data object.
|
static int |
DATA_FORWARD
Data object is
String dispatch handler name to which to forward. |
static int |
DATA_READER
Data object is a
Reader . |
static int |
DATA_REDIRECT
Data object is
String URL to which to redirect. |
static int |
DATA_STREAM
Data object is an
InputStream . |
static int |
DATA_STRING
Data object is a raw
String . |
static int |
DATA_THING
Data object is a portal
IThing . |
static int |
DATA_UNKNOWN
Data object is of unrecognized type.
|
static int |
DATA_VERSION
Data object is a portal
IVersion thing. |
static int |
DATA_W3C_NODE
Data object is a dom
Node . |
static String |
ID
Presentation data object identifier; used internally.
|
Modifier and Type | Method and Description |
---|---|
Object |
clone()
Creates a shallow copy of this.
|
String |
getApplication()
Deprecated.
'/ui/app/'
|
String |
getBaseResource()
Deprecated.
'/ui/app'
|
String |
getBuildVersion()
Portal build version string, such as '6.0.1.1.172'.
|
String |
getCanonicalServletPath()
Web context path plus servlet path minus trailing slash.
|
Object |
getContext()
Current JSP
PageContext . |
String |
getContextPath()
Web context path.
|
String |
getCss()
Deprecated.
'/ui/css/'
|
String |
getCurrentRequestURL()
Full path plus query string of current request,
such as '/meta/default/folder/0000001241?layout=properties'.
|
Object |
getDataObject()
The primary object representing the requested resource.
|
int |
getDataType()
Type of the principal object in this presentation cycle.
|
String |
getDefaultLayout()
Deprecated.
Name of default top-level JSP layout file for this data object type,
such as 'folder' or 'default'. May be null.
|
String |
getEditor()
Deprecated.
'/ui/editor/'
|
String |
getErrorLayout()
Name of the top-level JSP layout file used if an error occurs handling the request.
|
String |
getExtension()
Name of top-level JSP layout file used for presentation, such as 'jsp'.
|
String |
getFullServletPath()
Web context path plus servlet path plus trailing slash.
|
String |
getHelp()
Base help web-path, such as '/ui/help/'.
|
String |
getImages()
Standard-images web-path: '/ui/images/'.
|
String |
getIncludes()
Deprecated.
'/ui/include/'
|
String |
getLayout()
Name of top-level JSP layout file used for presentation,
such as '/ui/samplejsp/datatest' or 'default'.
|
String |
getLoginName()
Deprecated.
use
IContext . |
String |
getMimeType()
Media type of presentation, such as 'text/html'.
|
IObjectPool<? extends IPresentationData> |
getPool()
Deprecated.
Gets this object's pool. May return null.
|
String |
getPortlet()
Deprecated.
'/ui/portlets/wm_active_portlet'
|
String |
getPreviousRequestURL()
Full path plus query string of previous request in the current session,
such as '/meta/default/folder/0000001241?layout=wiring'.
|
String |
getRelativeTheme()
Deprecated.
'/ui/'
|
String |
getRequestedServerURL()
Actual server URL specified by client request,
such as 'http://portal.webmethods.com:8080'.
|
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'.
|
String |
getResourceID()
If this data object is an addressable portal object,
its addressable ID as a
String ;
otherwise, null. |
IURI |
getResourceURI()
If this data object is an addressable portal object,
its addressable ID as a portal
IURI ;
otherwise, null. |
String |
getScripts()
Deprecated.
'/ui/scripts/'
|
String |
getServerURL()
Configured cluster server URL, such as 'http://www.webmethods.com:8080'.
|
String |
getServletPath()
Servlet path.
|
IThingID |
getShell()
Deprecated.
hack for test-auto
current shell id
|
String |
getStyle()
Deprecated.
web-path to skin folder '/ui/skins/wm_skin_modern/'
|
String |
getSystemTitle()
Portal system title, such as 'webMethods Portal'.
|
String |
getWidgets()
Deprecated.
'/ui/portlets/'
|
String |
getWorkspaces()
Deprecated.
'/ui/workspaces/'
|
String |
getXslt()
Deprecated.
'/ui/xslt/'
|
IPresentationData |
init(Object dataObject,
int dataType,
HashMap<Object,Object> attributes)
Initializes this.
|
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.
|
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.
|
void |
setApplication(String applicationPath)
Deprecated.
'/ui/app/'
|
void |
setBaseResource(String baseResource)
Deprecated.
'/ui/app'
|
void |
setContext(Object context)
Current JSP
PageContext . |
void |
setContextPath(String contextPath)
Web context path.
|
void |
setCss(String cssPath)
Deprecated.
'/ui/css/'
|
void |
setCurrentRequestURL(String url)
Full path plus query string of current request,
such as '/meta/default/folder/0000001241?layout=properties'.
|
void |
setDataObject(Object obj)
The primary object representing the requested resource.
|
void |
setDataType(int dataType)
Type of the principal object in this presentation cycle.
|
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.
|
void |
setEditor(String editorPath)
Deprecated.
'/ui/editor/'
|
void |
setErrorLayout(String errorLayout)
Name of the top-level JSP layout file used if an error occurs handling the request.
|
void |
setExtension(String extension)
Name of top-level JSP layout file used for presentation, such as 'jsp'.
|
void |
setHelp(String help)
Base help web-path, such as '/ui/help/'.
|
void |
setImages(String images)
Standard-images web-path: '/ui/images/'.
|
void |
setIncludes(String includesPath)
Deprecated.
'/ui/include/'
|
void |
setLayout(String layout)
Name of top-level JSP layout file used for presentation,
such as '/ui/samplejsp/datatest' or 'default'.
|
void |
setLoginName(String loginName)
Deprecated.
use
IContext . |
void |
setMimeType(String mimeType)
Media type of presentation, such as 'text/html'.
|
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. |
void |
setPortlet(String portletPath)
Deprecated.
'/ui/portlets/wm_active_portlet'
|
void |
setPreviousRequestURL(String url)
Full path plus query string of previous request in the current session,
such as '/meta/default/folder/0000001241?layout=wiring'.
|
void |
setRelativeTheme(String relativeTheme)
Deprecated.
'/ui/'
|
void |
setRequestedServerURL(String serverURL)
Actual server URL specified by client request,
such as 'http://portal.webmethods.com:8080'.
|
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'.
|
void |
setResourceURI(IURI resourceURI)
If this data object is an addressable portal object,
its addressable ID as a portal
IURI ;
otherwise, null. |
void |
setScripts(String scriptsPath)
Deprecated.
'/ui/scripts/'
|
void |
setServerURL(String serverURL)
SConfigured cluster server URL, such as 'http://www.webmethods.com:8080'.
|
void |
setServletPath(String servletPath)
Servlet path.
|
void |
setStyle(String style)
Deprecated.
web-path to skin folder '/ui/skins/wm_skin_modern/'
|
void |
setWidgets(String widgetsPath)
Deprecated.
'/ui/portlets/'
|
void |
setWorkspaces(String workSpacesPath)
Deprecated.
'/ui/workspaces/'
|
void |
setXslt(String xsltPath)
Deprecated.
'/ui/xslt/'
|
static final String ID
static final int DATA_EMPTY
getDataObject()
,
Constant Field Valuesstatic final int DATA_UNKNOWN
getDataObject()
,
Constant Field Valuesstatic final int DATA_REDIRECT
String
URL to which to redirect.getDataObject()
,
Constant Field Valuesstatic final int DATA_FORWARD
String
dispatch handler name to which to forward.getDataObject()
,
Constant Field Valuesstatic final int DATA_STREAM
InputStream
.getDataObject()
,
Constant Field Valuesstatic final int DATA_STRING
String
.getDataObject()
,
Constant Field Valuesstatic final int DATA_W3C_NODE
Node
.getDataObject()
,
Constant Field Valuesstatic final int DATA_THING
IThing
.getDataObject()
,
Constant Field Valuesstatic final int DATA_DS_PRINCIPAL
com.webmethods.portal.service.directory.IDirectoryPrincipal
.getDataObject()
,
Constant Field Valuesstatic final int DATA_DIRECTORY
com.webmethods.portal.service.directory.IDirectoryService
.getDataObject()
,
Constant Field Valuesstatic final int DATA_VERSION
IVersion
thing.getDataObject()
,
Constant Field Valuesstatic final int DATA_READER
Reader
.getDataObject()
,
Constant Field ValuesIPresentationData init(Object dataObject, int dataType, HashMap<Object,Object> attributes)
dataObject
- Object to be presented.dataType
- Type of object to be presented.attributes
- (optional) Map of attributes associated with the presentation.Object getDataObject()
getDataType()
.setDataObject(java.lang.Object)
,
getDataType()
void setDataObject(Object obj)
setDataType(int)
.obj
- Data object or null.getDataObject()
,
setDataType(int)
int getDataType()
void setDataType(int dataType)
dataType
- Either:
getDataObject()
,
setDataType(int)
Object clone()
Object.clone()
void putAll(Map<?,?> t)
t
- mappings to be stored in this map.NullPointerException
- if the specified map is null.Map.putAll(java.util.Map<? extends K, ? extends V>)
String getLayout()
void setLayout(String layout)
layout
- JSP layout name or null.String getErrorLayout()
getLayout()
void setErrorLayout(String errorLayout)
errorLayout
- JSP layout name or null.String getDefaultLayout()
getLayout()
void setDefaultLayout(String defaultLayout)
defaultLayout
- JSP layout name or null.String getResource()
getLayout()
void setResource(String resource)
resource
- Full JSP layout name.String getExtension()
getLayout()
void setExtension(String extension)
extension
- File extension.String getBaseResource()
void setBaseResource(String baseResource)
String getHelp()
void setHelp(String help)
help
- Base help web-path.String getContextPath()
HttpServletRequest.getContextPath()
void setContextPath(String contextPath)
contextPath
- Web context path.HttpServletRequest.getContextPath()
String getServletPath()
HttpServletRequest.getServletPath()
void setServletPath(String servletPath)
servletPath
- Servlet path.HttpServletRequest.getServletPath()
String getFullServletPath()
String getCanonicalServletPath()
String getResourceID()
String
;
otherwise, null.IURI getResourceURI()
IURI
;
otherwise, null.void setResourceURI(IURI resourceURI)
IURI
;
otherwise, null.resourceURI
- Resource ID or null.Object getContext()
PageContext
.void setContext(Object context)
PageContext
.context
- JSP page context.String getRelativeTheme()
void setRelativeTheme(String relativeTheme)
String getApplication()
void setApplication(String applicationPath)
String getScripts()
void setScripts(String scriptsPath)
String getCss()
void setCss(String cssPath)
String getStyle()
IThingID getShell()
void setStyle(String style)
String getXslt()
void setXslt(String xsltPath)
String getImages()
void setImages(String images)
images
- Standard images web-path.String getEditor()
void setEditor(String editorPath)
String getWidgets()
void setWidgets(String widgetsPath)
String getPortlet()
void setPortlet(String portletPath)
String getWorkspaces()
void setWorkspaces(String workSpacesPath)
String getIncludes()
void setIncludes(String includesPath)
String getMimeType()
void setMimeType(String mimeType)
mimeType
- Media type.String getServerURL()
void setServerURL(String serverURL)
serverURL
- Configured cluster server URL.String getRequestedServerURL()
void setRequestedServerURL(String serverURL)
serverURL
- Actual server URL.String getCurrentRequestURL()
void setCurrentRequestURL(String url)
url
- Full path plus query string of current request.String getPreviousRequestURL()
void setPreviousRequestURL(String url)
url
- Full path plus query string of previous request in the current session.String getBuildVersion()
String getSystemTitle() throws PortalException
PortalException
void release()
IPooledObject.release()
IObjectPool<? extends IPresentationData> getPool()
IPooledObject.getPool()
void setPool(IObjectPool<? extends IPresentationData> pool)
setPool(com.webmethods.portal.system.pool.IObjectPool<? extends com.webmethods.portal.framework.presentation.IPresentationData>)
does nothing.