com.webmethods.portal.service.portlet
Interface IPortletURL

All Superinterfaces:

IPortletURL

public interface IPortletURL
extends IPortletURL

Represents portlet url.

Field Summary

static int	TOSTRINGTYPE_GET_URL
static int	TOSTRINGTYPE_HTML_FORM_ACTION
static int	TOSTRINGTYPE_HTML_FORM_INPUTS
static IURI	UNPREFIXED_PARAMETERS_URI

Fields inherited from interface com.webmethods.caf.portlet.IPortletURL

GLOBAL_PARAMETER_KEEP_STATE, GLOBAL_PARAMETER_RESET_STATE

Method Summary

IPortletURL	addPortletURL(IURI anotherPortlet) Creates portlet URL for another portlet on the the same target page.
void	clearParameters() Removs all portlet parameters from the URL
String	getBaseURL() Returns base url for this portlet url.
void	removeParameter(String name) Removes a portlet paremeter from the URL
void	setBaseURL(String url) Sets base url for this portlet url.
void	setParameter(String name, String[] value, boolean encodeValue) Sets portlet parameter String[] value..
void	setParameter(String name, String value, boolean encodeValue) Sets portlet parameter String value.
void	setPortletLayout(String pcaLayout) Sets PCA layout to display
void	setPortletMethod(String pcaMethod) Sets PCA method name to invoke on the portlet
void	setTargetAction(String targetAction) Sets PCA method name to invoke on the portlet
void	setTargetView(String targetView) Sets target view to display on the portlet
String	toString(int type) Returns either full GET url or HTML form action plus set of hidden fields

Methods inherited from interface com.webmethods.caf.portlet.IPortletURL

addPortletURL, clearState, getPortletNamespace, removeGlobalParameter, removeParameter, setAXSRFT, setGlobalParameter, setParameter, setParameter, setPortlet

Field Detail

UNPREFIXED_PARAMETERS_URI

static final IURI UNPREFIXED_PARAMETERS_URI

TOSTRINGTYPE_GET_URL

static final int TOSTRINGTYPE_GET_URL

See Also:

Constant Field Values

TOSTRINGTYPE_HTML_FORM_ACTION

static final int TOSTRINGTYPE_HTML_FORM_ACTION

See Also:

Constant Field Values

TOSTRINGTYPE_HTML_FORM_INPUTS

static final int TOSTRINGTYPE_HTML_FORM_INPUTS

See Also:

Constant Field Values

Method Detail

setBaseURL

void setBaseURL(String url)
                throws PortalException

Sets base url for this portlet url. By default base url is current portal resource, but can be set to any other resource or even any other valid full url like http://myotherportal:8080/portal/alias/ Valid values are: /folder.public /folder.public?p1=p2 http://myotherportal:8080/folder.public?p1=p2&p3=p3

Specified by:

setBaseURL in interface IPortletURL

Parameters:

url -

Throws:

PortalException

getBaseURL

String getBaseURL()

Returns base url for this portlet url. By default it's current portal resource, i.e. http://myotherportal:8080/

Specified by:

getBaseURL in interface IPortletURL

Returns:

current base url

See Also:

IPortletURL.setBaseURL(String)

setPortletMethod

void setPortletMethod(String pcaMethod)
                      throws PortalException

Sets PCA method name to invoke on the portlet

Specified by:

setPortletMethod in interface IPortletURL

Parameters:

pcaMethod - name of the method

Throws:

PortalException

setTargetAction

void setTargetAction(String targetAction)
                     throws PortalException

Sets PCA method name to invoke on the portlet

Specified by:

setTargetAction in interface IPortletURL

Parameters:

pcaMethod - name of the method

Throws:

PortalException

setTargetView

void setTargetView(String targetView)
                   throws PortalException

Sets target view to display on the portlet

Specified by:

setTargetView in interface IPortletURL

Parameters:

targetView -

Throws:

PortalException

setPortletLayout

void setPortletLayout(String pcaLayout)
                      throws PortalException

Sets PCA layout to display

Specified by:

setPortletLayout in interface IPortletURL

Parameters:

pcaLayout - the layout to display

Throws:

PortalException

clearParameters

void clearParameters()

Removs all portlet parameters from the URL

Specified by:

clearParameters in interface IPortletURL

removeParameter

void removeParameter(String name)

Removes a portlet paremeter from the URL

Specified by:

removeParameter in interface IPortletURL

Parameters:

name - the name of the parameter to remove

setParameter

void setParameter(String name,
                  String value,
                  boolean encodeValue)

Sets portlet parameter String value. Allows to specifiy whether to encode the value. Not encoding the value usually is useful when the url gets some post processing

Specified by:

setParameter in interface IPortletURL

Parameters:

name - the portlet parameter name

value - the parameter value

encodeValue - false to not encode the value.

setParameter

void setParameter(String name,
                  String[] value,
                  boolean encodeValue)

Sets portlet parameter String[] value.. Allows to specifiy whether to encode the value.

Specified by:

setParameter in interface IPortletURL

Parameters:

name - the portlet parameter name

value - the parameter value

encodeValue - false to not encode the value

See Also:

IPortletURL.setParameter(String, String, boolean)

addPortletURL

IPortletURL addPortletURL(IURI anotherPortlet)
                          throws PortalException

Creates portlet URL for another portlet on the the same target page. The returned url is used for customizing parameters and layout for this other

Parameters:

anotherPortlet -

Returns:

Throws:

PortalException

toString

String toString(int type)

Returns either full GET url or HTML form action plus set of hidden fields

Parameters:

type - is IPortletURL.TOSTRINGTYPE_HTML_FORM_ACTION and IPortletURL.TOSTRINGTYPE_HTML_FORM_INPUTS or IPortletURL.TOSTRINGTYPE_GET_URL

Returns:

string representation for HTML form action or hidden fields