KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cocoon > portal > coplet > CopletFactory


1 /*
2  * Copyright 1999-2002,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 package org.apache.cocoon.portal.coplet;
17
18 import org.apache.cocoon.ProcessingException;
19
20 /**
21  * This factory is for creating and managing coplet objects
22  *
23  * @author <a HREF="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
24  *
25  * @version CVS $Id: CopletFactory.java 30932 2004-07-29 17:35:38Z vgritsenko $
26  */
27 public interface CopletFactory {
28     
29     String JavaDoc ROLE = CopletFactory.class.getName();
30     
31     void prepare(CopletData copletData)
32     throws ProcessingException;
33     
34     void prepare(CopletInstanceData copletInstanceData)
35     throws ProcessingException;
36     
37     /**
38      * Create a new coplet instance.
39      * This is also registered at the profile manager.
40      */
41     CopletInstanceData newInstance(CopletData copletData)
42     throws ProcessingException;
43     
44     /**
45      * Remove the coplet instance data.
46      * This is also unregistered at the profile manager.
47      */
48     void remove(CopletInstanceData copletInstanceData)
49     throws ProcessingException;
50 }
51
Popular Tags