PortletInvoker - JBOSS Portal 2.4 API 英文版文档

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jboss.portal.portlet
Interface PortletInvoker

All Known Subinterfaces:: WSRPConsumer

All Known Implementing Classes:: PortletContainerInvoker, PortletInvokerSupport, StatefulPortletInvoker, TestPortletInvoker, WSRPConsumerImpl

public interface PortletInvoker

The PortletInvoker is an abstraction for a set of portlets. It defines a context for performing operations are possible on a particular portlet among the set.

Method Summary

java.lang.String createClone(java.lang.String portletId)
          Clone a portlet.

void destroyClone(java.lang.String portletId)
          Destroy a cloned portlet.

Portlet getPortlet(java.lang.String portletId)
          Get information about a specific portlet.

java.util.Set getPortlets()
          Return the set of portlet exposed.

ValueMap getProperties(java.lang.String portletId)
          Return the properties of the specified portlet.

void invoke(PortletInvocation invocation)
          Invoke an operation on a specific portlet.

void setProperties(java.lang.String portletId, ValueMap properties)
          Set the properties on the specified portlet.

Method Detail

getPortlets

public java.util.Set getPortlets()
                          throws PortletInvokerException

Return the set of portlet exposed.

Returns:: the set of exposed portlets
Throws:: PortletInvokerException

getPortlet

public Portlet getPortlet(java.lang.String portletId)
                   throws java.lang.IllegalArgumentException,
                          PortletInvokerException

Get information about a specific portlet.

Parameters:: portletId - the portlet identifier in the context of this invoker
Returns:: the PortletInfo for the specified portlet
Throws:: java.lang.IllegalArgumentException - if the portletId is null; PortletInvokerException

invoke

public void invoke(PortletInvocation invocation)
            throws java.lang.IllegalArgumentException,
                   PortletInvokerException

Invoke an operation on a specific portlet.

Parameters:: invocation - the portlet invocation
Throws:: java.lang.IllegalArgumentException - if the invocation is null; PortletInvokerException

createClone

public java.lang.String createClone(java.lang.String portletId)
                             throws java.lang.IllegalArgumentException,
                                    PortletInvokerException,
                                    java.lang.UnsupportedOperationException

Clone a portlet.

Returns:: the clone id
Throws:: java.lang.IllegalArgumentException - if the portletId is null; java.lang.UnsupportedOperationException - if the invoker does not support this operation; PortletInvokerException

destroyClone

public void destroyClone(java.lang.String portletId)
                  throws java.lang.IllegalArgumentException,
                         PortletInvokerException,
                         java.lang.UnsupportedOperationException

Destroy a cloned portlet.

Parameters:: portletId - the clone id
Throws:: java.lang.IllegalArgumentException - if the portletId is null; java.lang.UnsupportedOperationException - if the invoker does not support this operation; PortletInvokerException

getProperties

public ValueMap getProperties(java.lang.String portletId)
                       throws java.lang.IllegalArgumentException,
                              PortletInvokerException,
                              java.lang.UnsupportedOperationException

Return the properties of the specified portlet.

Parameters:: portletId - the portlet id
Returns:: the properties
Throws:: java.lang.IllegalArgumentException - if the portletId is null; java.lang.UnsupportedOperationException - if the invoker does not support this operation; PortletInvokerException

setProperties

public void setProperties(java.lang.String portletId,
                          ValueMap properties)
                   throws java.lang.IllegalArgumentException,
                          PortletInvokerException,
                          java.lang.UnsupportedOperationException

Set the properties on the specified portlet.

Parameters:: portletId - the portlet id; properties - the new properties
Throws:: java.lang.IllegalArgumentException - if the portletId or the properties is null; java.lang.UnsupportedOperationException - if the invoker does not support this operation; PortletInvokerException