You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by we...@apache.org on 2004/06/10 22:08:15 UTC

cvs commit: jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/components/portletentity PortletEntityAccessComponent.java

weaver      2004/06/10 13:08:15

  Modified:    jetspeed-api/src/java/org/apache/jetspeed/components/portletentity
                        PortletEntityAccessComponent.java
  Log:
  Moved some logic out of WindowAccessorImpl into PortletEntityAccessComponent.
  It is now very easy to generate PortletEntities from an existing Fragment.  This negates
  the need to pre-load portlet entites in the quickStart goal.
  
  Revision  Changes    Path
  1.2       +99 -8     jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/components/portletentity/PortletEntityAccessComponent.java
  
  Index: PortletEntityAccessComponent.java
  ===================================================================
  RCS file: /home/cvs/jakarta-jetspeed-2/jetspeed-api/src/java/org/apache/jetspeed/components/portletentity/PortletEntityAccessComponent.java,v
  retrieving revision 1.1
  retrieving revision 1.2
  diff -u -r1.1 -r1.2
  --- PortletEntityAccessComponent.java	5 Jun 2004 05:09:29 -0000	1.1
  +++ PortletEntityAccessComponent.java	10 Jun 2004 20:08:15 -0000	1.2
  @@ -16,6 +16,7 @@
   package org.apache.jetspeed.components.portletentity;
   
   import org.apache.jetspeed.om.common.portlet.MutablePortletEntity;
  +import org.apache.jetspeed.om.page.Fragment;
   import org.apache.pluto.om.common.ObjectID;
   import org.apache.pluto.om.entity.PortletEntity;
   import org.apache.pluto.om.portlet.PortletDefinition;
  @@ -31,18 +32,108 @@
    */
   public interface PortletEntityAccessComponent
   {
  +    /**
  +     * 
  +     * <p>
  +     * getPortletEntity
  +     * </p>
  +     *
  +     * @param id
  +     * @return
  +     */
   	MutablePortletEntity getPortletEntity(ObjectID id);
  -
  -
  -//	MutablePortletEntity getPortletEntity(PortletDefinition portletDefinition, String portletName);
  +    
  +	/**
  +	 * 
  +	 * <p>
  +	 * generateEntityFromFragment
  +	 * </p>
  +	 *
  +	 * @param fragment
  +	 * @param principal
  +	 * @return
  +	 * @throws PortletEntityNotGeneratedException
  +	 */
  +	MutablePortletEntity generateEntityFromFragment(Fragment fragment, String principal) throws PortletEntityNotGeneratedException;
  +	
  +	/**
  +	 * 
  +	 * <p>
  +	 * generateEntityFromFragment
  +	 * </p>
  +	 *
  +	 * @param fragment
  +	 * @return
  +	 * @throws PortletEntityNotGeneratedException
  +	 */
  +	MutablePortletEntity generateEntityFromFragment(Fragment fragment) throws PortletEntityNotGeneratedException;
          
  -
  +	/**
  +	 * 
  +	 * <p>
  +	 * generateEntityKey
  +	 * </p>
  +	 *
  +	 * @param fragment
  +	 * @param principal
  +	 * @return
  +	 */
  +	ObjectID generateEntityKey(Fragment fragment, String principal);
  +
  +	/**
  +	 * 
  +	 * <p>
  +	 * newPortletEntityInstance
  +	 * </p>
  +	 *
  +	 * @param portletDefinition
  +	 * @return
  +	 */
   	MutablePortletEntity newPortletEntityInstance(PortletDefinition portletDefinition);
  -
  -
  +	
  +	/**
  +	 * 
  +	 * <p>
  +	 * getPortletEntityForFragment
  +	 * </p>
  +	 *
  +	 * @param fragment
  +	 * @param principal
  +	 * @return
  +	 */
  +	MutablePortletEntity getPortletEntityForFragment(Fragment fragment, String principal);
  +	
  +	/**
  +	 * 
  +	 * <p>
  +	 * getPortletEntityForFragment
  +	 * </p>
  +	 *
  +	 * @param fragment
  +	 * @return
  +	 */
  +	MutablePortletEntity getPortletEntityForFragment(Fragment fragment);
  +    
  +	/**
  +	 * 
  +	 * <p>
  +	 * removePortletEntity
  +	 * </p>
  +	 *
  +	 * @param portletEntity
  +	 * @throws PortletEntityNotDeletedException
  +	 */
   	void removePortletEntity(PortletEntity portletEntity) throws PortletEntityNotDeletedException;
   
  -
  +    /**
  +     * 
  +     * <p>
  +     * storePortletEntity
  +     * </p>
  +     *
  +     * @param portletEntity
  +     * @throws PortletEntityNotStoredException
  +     */
   	void storePortletEntity(PortletEntity portletEntity) throws PortletEntityNotStoredException;
   
   }
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jetspeed-dev-help@jakarta.apache.org