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.aspect;
18:
19: import java.util.Map;
20:
21: /**
22: * This interface marks an object that can be used by aspects.
23: * An aspect can store any arbitrary information in an aspectalizable object.
24: *
25: * @author <a href="mailto:cziegeler@s-und-n.de">Carsten Ziegeler</a>
26: * @author <a href="mailto:volker.schmitt@basf-it-services.com">Volker Schmitt</a>
27: *
28: * @version CVS $Id: Aspectalizable.java 433543 2006-08-22 06:22:54Z crossley $
29: */
30: public interface Aspectalizable {
31:
32: /**
33: * Get the data associated with an aspect
34: * @param aspectName The aspect name
35: * @return The data or null if the aspect is not associated with this object
36: */
37: Object getAspectData(String aspectName);
38:
39: /**
40: * Set the data associated with an aspect
41: * The data is only set if the object is associated with the given aspect
42: * @param aspectName The aspect name
43: * @param data The data
44: */
45: void setAspectData(String aspectName, Object data);
46:
47: /**
48: * Return all aspect datas
49: * @return A map of data objects, the keys are built by the aspect names
50: */
51: Map getAspectDatas();
52:
53: /**
54: * Return all persistent aspect datas
55: * @return A map of data objects, the keys are built by the aspect names
56: */
57: Map getPersistentAspectData();
58:
59: void addPersistentAspectData(String aspectName, Object data);
60:
61: /**
62: * Is this aspect supported
63: */
64: boolean isAspectSupported(String aspectName);
65:
66: /**
67: * This method is invoked once to set the handler
68: */
69: void setAspectDataHandler(AspectDataHandler handler);
70: }
|