01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.portal.layout;
18:
19: import java.util.List;
20:
21: import org.apache.cocoon.ProcessingException;
22:
23: /**
24: * This factory is for creating and managing layout objects
25: *
26: * @author <a href="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
27: * @author <a href="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
28: *
29: * @version CVS $Id: LayoutFactory.java 433543 2006-08-22 06:22:54Z crossley $
30: */
31: public interface LayoutFactory {
32:
33: String ROLE = LayoutFactory.class.getName();
34:
35: /**
36: * This method is invoked for a newly loaded profile
37: */
38: void prepareLayout(Layout layout) throws ProcessingException;
39:
40: /**
41: * Create a new layout instance.
42: * The instance is also registered at the profile manager.
43: */
44: Layout newInstance(String name) throws ProcessingException;
45:
46: /**
47: * Remove the layout instance.
48: * The instance (and all childs) will also be unregistered from
49: * the profile manager.
50: */
51: void remove(Layout layout) throws ProcessingException;
52:
53: List getLayoutDescriptions();
54:
55: }
|