View Javadoc

1   /*
2    * Copyright 2000-2001,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.jetspeed.services.portletfactory;
18  
19  //jetspeed stuff
20  import org.apache.jetspeed.portal.Portlet;
21  import org.apache.jetspeed.portal.PortletException;
22  import org.apache.jetspeed.om.profile.Entry;
23  import org.apache.turbine.services.Service;
24   
25  /***
26   * This service handles the creation of Portlet objects
27   * 
28   * @author <a href="mailto:raphael@apache.org">RaphaŽl Luta</a>
29   * @version $Id: PortletFactoryService.java,v 1.4 2004/02/23 03:36:42 jford Exp $
30   */
31  public interface PortletFactoryService extends Service
32  {
33  
34      /*** The default control to use when none is specified */
35      public String SERVICE_NAME = "PortletFactory";
36              
37      /***
38       * Given a PSML Entry return an instanciated Portlet.
39       *
40       * @param entry a PSML Entry describing a portlet
41       * @return an instanciated portlet corresponding to this entry
42       */
43      public Portlet getPortlet( Entry entry ) throws PortletException;
44  
45      /***
46       * Given a Portlet registry entry name, instanciate it
47       *
48       * @param name the name of a portlet in the registry
49       * @return an instanciated portlet corresponding to this entry
50       */
51      public Portlet getPortlet( String name, String id ) throws PortletException;
52  }
53