01: /*
02: * <copyright>
03: *
04: * Copyright 1997-2004 BBNT Solutions, LLC
05: * under sponsorship of the Defense Advanced Research Projects
06: * Agency (DARPA).
07: *
08: * You can redistribute this software and/or modify it under the
09: * terms of the Cougaar Open Source License as published on the
10: * Cougaar Open Source Website (www.cougaar.org).
11: *
12: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
13: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
14: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
15: * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
16: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
17: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
18: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
22: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23: *
24: * </copyright>
25: */
26:
27: package org.cougaar.planning.ldm.plan;
28:
29: /** Annotatable marks a Plan Object which supports attachment
30: * of a plugin annotation.
31: **/
32:
33: public interface Annotatable {
34: /**
35: * Get the plugin annotation (if any) attached to the Annotatable
36: * object.
37: *
38: * Only the creating plugin of an Annotatable object
39: * should use this accessor.
40: *
41: * @see org.cougaar.planning.ldm.plan.Annotation
42: * @return the Annotation or null.
43: **/
44: Annotation getAnnotation();
45:
46: /**
47: * Set the plugin annotation attached to the Annotatable
48: * Object.
49: *
50: * Only the creating plugin of an Annotatable object
51: * should use this accessor.
52: *
53: * Plugins are encouraged but not required to only
54: * set the annotation one.
55: *
56: * @see org.cougaar.planning.ldm.plan.Annotation
57: **/
58: void setAnnotation(Annotation pluginAnnotation);
59: }
|