[jboss-cvs] jboss-portal/portlet/src/main/org/jboss/portal/portlet ...

[Julien Viet]

  User: julien  
  Date: 06/08/10 04:02:34

  Modified:    portlet/src/main/org/jboss/portal/portlet 
                        PortletInvoker.java
  Log:
  improved javadoc for management operations that can throw UnsupportedOperationException if the invoker cannot perform management operation
  
  Revision  Changes    Path
  1.16      +9 -5      jboss-portal/portlet/src/main/org/jboss/portal/portlet/PortletInvoker.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: PortletInvoker.java
  ===================================================================
  RCS file: /cvsroot/jboss/jboss-portal/portlet/src/main/org/jboss/portal/portlet/PortletInvoker.java,v
  retrieving revision 1.15
  retrieving revision 1.16
  diff -u -b -r1.15 -r1.16
  --- PortletInvoker.java	31 Jul 2006 19:29:52 -0000	1.15
  +++ PortletInvoker.java	10 Aug 2006 08:02:34 -0000	1.16
  @@ -31,7 +31,7 @@
    * operations are possible on a particular portlet among the set.
    *
    * @author <a href="mailto:julien at jboss.org">Julien Viet</a>
  - * @version $Revision: 1.15 $
  + * @version $Revision: 1.16 $
    */
   public interface PortletInvoker
   {
  @@ -64,16 +64,18 @@
       *
       * @return the clone id
       * @throws IllegalArgumentException if the portletId is null
  +    * @throws UnsupportedOperationException if the invoker does not support this operation
       */
  -   String createClone(String portletId) throws IllegalArgumentException, PortletInvokerException;
  +   String createClone(String portletId) throws IllegalArgumentException, PortletInvokerException, UnsupportedOperationException;
   
      /**
       * Destroy a cloned portlet.
       *
       * @param portletId the clone id
       * @throws IllegalArgumentException if the portletId is null
  +    * @throws UnsupportedOperationException if the invoker does not support this operation
       */
  -   void destroyClone(String portletId) throws IllegalArgumentException, PortletInvokerException;
  +   void destroyClone(String portletId) throws IllegalArgumentException, PortletInvokerException, UnsupportedOperationException;
   
      /**
       * Return the properties of the specified portlet.
  @@ -81,8 +83,9 @@
       * @param portletId the portlet id
       * @return the properties
       * @throws IllegalArgumentException if the portletId is null
  +    * @throws UnsupportedOperationException if the invoker does not support this operation
       */
  -   ValueMap getProperties(String portletId) throws IllegalArgumentException, PortletInvokerException;
  +   ValueMap getProperties(String portletId) throws IllegalArgumentException, PortletInvokerException, UnsupportedOperationException;
   
      /**
       * Set the properties on the specified portlet.
  @@ -90,6 +93,7 @@
       * @param portletId  the portlet id
       * @param properties the new properties
       * @throws IllegalArgumentException if the portletId or the properties is null
  +    * @throws UnsupportedOperationException if the invoker does not support this operation
       */
  -   void setProperties(String portletId, ValueMap properties) throws IllegalArgumentException, PortletInvokerException;
  +   void setProperties(String portletId, ValueMap properties) throws IllegalArgumentException, PortletInvokerException, UnsupportedOperationException;
   }