*** This class is subject to change ***

com.sas.portal.portlet
Interface RemotePortletContext

All Superinterfaces:

All Known Implementing Classes:

public interface RemotePortletContext

extends java.io.Serializable

Common storage area assigned to each portlet instance. For each unique user session that interacts with a given portlet, a separate instance of a PortletContext is created and stored in the user session.

Since:

09/02/2002

Method Summary

String	getId() Get ID for the portlet context
String	getMode() get the mode for the portlet.
String	getOriginatingHost() Get the originating host stored in the PortletContext.
String	getOriginatingLocale() Get the originating locale stored in the PortletContext.
int	getOriginatingPort() Get the originating port stored in the PortletContext.
String	getOriginatingWebContext() Get the originating web context stored in the PortletContext.
String	getPageEntityKey() Get the page entity key stored in this PortletContext
String	getPortletEntityKey() Get the portlet entity key stored in this PortletContext
String	getProtocol() Get the protocol stored in the PortletContext.
void	resetMode() Reset the mode of the portlet to the default mode.
String	resolveURLForActionName(String name) This will look up all actions stored in the PortletInfo that is attached to this PortletContext.

Method Detail

getId

public String getId()

Get ID for the portlet context

Returns:

java.lang.String - the portlet context ID

getPageEntityKey

public String getPageEntityKey()

Get the page entity key stored in this PortletContext

Returns:

java.lang.String - the Page entity key stored in this PortletContext

getPortletEntityKey

public String getPortletEntityKey()

Get the portlet entity key stored in this PortletContext

Returns:

java.lang.String - the Portlet entity key stored in this PortletContext

getProtocol

public String getProtocol()

Get the protocol stored in the PortletContext. Support for Remote Portlets

Returns:

java.lang.String - the protocol stored in the PortletContext

getOriginatingHost

public String getOriginatingHost()

Get the originating host stored in the PortletContext. Support for Remote Portlets

Returns:

java.lang.String - the originating host stored in the PortletContext

getOriginatingWebContext

public String getOriginatingWebContext()

Get the originating web context stored in the PortletContext. Support for Remote Portlets

Returns:

java.lang.String - the originating web context stored in the PortletContext

getOriginatingPort

public int getOriginatingPort()

Get the originating port stored in the PortletContext. Support for Remote Portlets

Returns:

java.lang.int - the originating port stored in the PortletContext

getOriginatingLocale

public String getOriginatingLocale()

Get the originating locale stored in the PortletContext. Support for Remote Portlets

Returns:

java.lang.int - the originating locale stored in the PortletContext

resolveURLForActionName

public String resolveURLForActionName(String name)

This will look up all actions stored in the PortletInfo that is attached to this PortletContext. It will then return the URL first PortletActionInfoInterface object whose name matches the name passed in.

Returns:

java.lang.String - the URL for the action name passed in

getMode

public String getMode()

get the mode for the portlet. This is to support state changes for portlets. Choices: PortletConstants.DISPLAY_MODE PortletConstants.EDIT_MODE PortletConstants.NORENDER_MODE

Returns:

java.lang.String - the current mode for the portlet

resetMode

public void resetMode()

Reset the mode of the portlet to the default mode. Only valid if the portlet is not in NORENDER_MODE

*** This class is subject to change ***