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.core.qos.ca;
28:
29: /**
30: * A Receptacle represents a role in a {@link CoordinationArtifact}
31: * from the perspective of the {@link RolePlayer}. This is the
32: * player's only interface to the artifact. The correspdonding entity
33: * in the Artifact is a {@link Facet}. This naming convention is
34: * deliberately suggestive of the CORBA Component Model (CCM), since
35: * the functions of these two interfaces are roughly equivalent to the
36: * similarly named entities in CCM. By analogy, the {@link
37: * CoordinationArtifact} itself corresponds to a CCM Component.
38: */
39: public interface Receptacle extends BlackboardExecutor {
40: /**
41: * Used by clients to assert a new fact into the Facet's
42: * fact-base. The fact itself is a blackbox.
43: */
44: public void assertFact(Object fact);
45:
46: /**
47: * Used by clients to retract a fact from the Facet's
48: * fact-base. The fact itself is a blackbox.
49: */
50: public void retractFact(Object fact);
51:
52: /**
53: * Returns the kind of the {@link CoordinationArtifactProvider}
54: */
55: public String getArtifactKind();
56:
57: /**
58: * Returns the id of the specific {@link CoordinationArtifact}
59: * (not to be confused with the Provider kind) which owns this
60: * Facet.
61: */
62: public String getArtifactId();
63:
64: }
|