weaver 2003/08/06 12:45:54
Added: commons/src/java/org/apache/jetspeed/om/common/entity
InitablePortletEntity.java
Log:
Created the InitablePortletEntity so that the PortletEntityService can
initialize portlet entities on a per request basis
Revision Changes Path
1.1
jakarta-jetspeed-2/commons/src/java/org/apache/jetspeed/om/common/entity/InitablePortletEntity.java
Index: InitablePortletEntity.java
===================================================================
/* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 2000-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software itself,
* if and wherever such third-party acknowledgments normally appear.
*
* 4. The names "Apache" and "Apache Software Foundation" and
* "Apache Jetspeed" must not be used to endorse or promote products
* derived from this software without prior written permission. For
* written permission, please contact [EMAIL PROTECTED]
*
* 5. Products derived from this software may not be called "Apache",
* "Apache Jetspeed", nor may "Apache" appear in their name, without
* prior written permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*/
package org.apache.jetspeed.om.common.entity;
import java.io.Serializable;
import org.apache.pluto.om.common.PreferenceSet;
import org.apache.pluto.om.entity.PortletEntity;
import org.apache.pluto.om.entity.PortletEntityCtrl;
import org.apache.pluto.om.portlet.PortletDefinition;
/**
* <p>
* RecyclablePortletEntity
* </p>
*
* Extends the <code>org.apache.pluto.om.entity.PortletEntity</code>
* to provide <code>init(org.apache.pluto.om.portlet.PortletDefinition,
portletName)</code>
* and <code>serviceRequest(org.apache.jetspeed.request.RequestContext)</code>
* methods.
*
* @author <a href="mailto:[EMAIL PROTECTED]">Scott T. Weaver</a>
* @version $Id: InitablePortletEntity.java,v 1.1 2003/08/06 19:45:54 weaver Exp $
*
*/
public interface InitablePortletEntity extends PortletEntity, PortletEntityCtrl,
Serializable
{
/**
* Called once to initialize a specific portlet entity with the
* <code>PortletDefinition</code> that it represents and it's
* <code>instanceName</code> which is unique to all PortletEntities
* whose parent is of the same <code>PortletDefinition</code>.
* @throws java.lang.IllegalArgumentException if either
<code>portletDefinition</code>
* or <code>portletName </code> is <code>null</code>
* @param portletDefinition PortletDefinition this PortletEntity uses
* @param instanceName the unique name of this entity with regards to all
* PortletEntites that support the same <code>portletDefinition.</code>
*/
void init(PortletDefinition portletDefinition, String instanceName);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
