You are viewing a plain text version of this content. The canonical link for it is here.
Posted to pluto-scm@portals.apache.org by dd...@apache.org on 2007/02/22 05:31:36 UTC

svn commit: r510392 - /portals/pluto/trunk/pluto-container/src/main/java/org/apache/pluto/spi/optional/PortletRegistryService.java

Author: ddewolf
Date: Wed Feb 21 20:31:36 2007
New Revision: 510392

URL: http://svn.apache.org/viewvc?view=rev&rev=510392
Log:
Javadocs

Modified:
    portals/pluto/trunk/pluto-container/src/main/java/org/apache/pluto/spi/optional/PortletRegistryService.java

Modified: portals/pluto/trunk/pluto-container/src/main/java/org/apache/pluto/spi/optional/PortletRegistryService.java
URL: http://svn.apache.org/viewvc/portals/pluto/trunk/pluto-container/src/main/java/org/apache/pluto/spi/optional/PortletRegistryService.java?view=diff&rev=510392&r1=510391&r2=510392
==============================================================================
--- portals/pluto/trunk/pluto-container/src/main/java/org/apache/pluto/spi/optional/PortletRegistryService.java (original)
+++ portals/pluto/trunk/pluto-container/src/main/java/org/apache/pluto/spi/optional/PortletRegistryService.java Wed Feb 21 20:31:36 2007
@@ -19,12 +19,10 @@
 import org.apache.pluto.descriptors.portlet.PortletAppDD;
 import org.apache.pluto.descriptors.portlet.PortletDD;
 import org.apache.pluto.PortletContainerException;
-import org.apache.pluto.internal.InternalPortletContext;
 
 import javax.portlet.PortletContext;
 import javax.portlet.PortletConfig;
 import java.util.Iterator;
-import java.util.Map;
 
 /**
  * Interface defining the services used by the container
@@ -76,16 +74,31 @@
     /**
      * Retrieve the PortletContext for the specified applicationId
      * 
-     * @param applicationId
-     * @return
-     * @throws PortletContainerException
+     * @param applicationId context identifier
+     * @return portlet context
+     * @throws PortletContainerException if internal error occurs
      */
     PortletContext getPortletContext(String applicationId)
         throws PortletContainerException;
 
+    /**
+     * Retreive the portlet descriptor for the given portlet.
+     *
+     * @param applicationId context identifier
+     * @param portletName portlet name
+     * @return descriptor
+     * @throws PortletContainerException if unexpected error
+     */
     PortletDD getPortletDescriptor(String applicationId, String portletName)
         throws PortletContainerException;
 
+    /**
+     * Retrieve the portlet configuration for the specified portlet
+     * @param applicationId context identifier
+     * @param portletName portlet name
+     * @return portletconfig
+     * @throws PortletContainerException if internal error occurs
+     */
     PortletConfig getPortletConfig(String applicationId, String portletName)
         throws PortletContainerException;