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

com.sas.portal.portlet
Interface PortletActionInterface

All Superinterfaces:

All Known Implementing Classes:

DefaultPortletAction,

public interface PortletActionInterface

extends java.io.Serializable

Interface which all portlet actions must implement. The service() method can be overridden to set properties on the response, such as response.setContentType("text/html;charset=UTF-8") to allow non-Latin1 languages render via UTF-8. It also allows you to set and retrieve an instance of PortletActionInfoInterface.

Since:

09/02/2002

Method Summary

PortletActionInfoInterface	getInfo() Gets the deployment descriptor metadata corresponding to this concrete action instance.
String	service(HttpServletRequest request, HttpServletResponse response, PortletContext context) Integration point for portlet actions.
void	setInfo(PortletActionInfoInterface info) Sets the PortletActionInfoInterface for the given PortletAction.

Method Detail

service

public String service(HttpServletRequest request,
                      HttpServletResponse response,
                      PortletContext context)
               throws Exception

Integration point for portlet actions.

Parameters:

request - The HtppServletRequest associated with the method invocation

response - HttpServletResponse associated with the method invocation

context - PortletContext mapped to the request path

Returns:

java.lang.String - representing a valid URL.

Throws:

Exception - if anything went wrong

See Also:

service(HttpServletRequest, HttpServletResponse, PortletContext)

setInfo

public void setInfo(PortletActionInfoInterface info)

Sets the PortletActionInfoInterface for the given PortletAction. This allows each concrete portlet action class to have a reference to its deployment descriptor metadata.

Parameters:

info - PortletActionInfoInterface - deployment descriptor metadata

PortletActionInfoInterface - the PortletActionInfoInterface to set

See Also:

setInfo(PortletActionInfoInterface)

getInfo

public PortletActionInfoInterface getInfo()

Gets the deployment descriptor metadata corresponding to this concrete action instance.

Returns:

PortletActionInfoInterface - deployment descriptor metadata

See Also:

getInfo()

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