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: * See the package javadoc for more details on CoordinationArtifacts.
31: * The primary job of the Artifact is to link {@link Facet}s to {@link
32: * RolePlayer}s, as specified by a {@link ConnectionSpec}.
33: */
34: public interface CoordinationArtifact {
35: /**
36: * Returns true iff the Artifact matches given spec. This will
37: * only be called with specs that the Artifact's provider has
38: * already said it supports. The default implementation in {@link
39: * CoordinationArtifactImpl} therefore returns true for all specs
40: * in which the artifact-id field matches the artifact's id.
41: */
42: public boolean matches(ConnectionSpec spec);
43:
44: /**
45: * Does the linkage between a {@link Facet}, which is generally
46: * created on the fly based on the spec, and the player. The
47: * default implementation in {@link CoordinationArtifactImpl}
48: * handles this by deferring the creation to an abstract method.
49: *
50: */
51: public void provideFacet(ConnectionSpec spec, RolePlayer player);
52:
53: /**
54: * Returns the {@link CoordinationArtifactProvider} kind.
55: */
56: public String getArtifactKind();
57:
58: /**
59: * Returns the Artifact's id (not to be confused with the
60: * Provider's kind).
61: */
62: public String getArtifactId();
63:
64: }
|