01: /*
02: * Copyright 2004-2007 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
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.springframework.webflow.definition;
17:
18: import org.springframework.webflow.core.collection.AttributeMap;
19:
20: /**
21: * An interface to be implemented by objects that are annotated with attributes
22: * they wish to expose to clients.
23: *
24: * @author Keith Donald
25: * @author Erwin Vervaet
26: */
27: public interface Annotated {
28:
29: /**
30: * Returns a short summary of this object, suitable for display as
31: * an icon caption or tool tip.
32: * @return the caption
33: */
34: public String getCaption();
35:
36: /**
37: * Returns a longer, more detailed description of this object.
38: * @return the description
39: */
40: public String getDescription();
41:
42: /**
43: * Returns an immutable attribute map containing the attributes annotating
44: * this object. These attributes provide descriptive characteristics or
45: * properties that may affect object behavior.
46: * @return the attribute map
47: */
48: public AttributeMap getAttributes();
49:
50: }
|