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.domain;
28:
29: import java.util.Set;
30:
31: import org.cougaar.core.blackboard.DirectiveMessage;
32: import org.cougaar.core.blackboard.EnvelopeTuple;
33: import org.cougaar.core.mts.MessageAddress;
34:
35: /**
36: * A domain provides problem-specific support for blackboard
37: * objects, such as an object {@link Factory} and {@link
38: * LogicProvider}s to automate object behaviors and communicate with
39: * remote agents.
40: * <p>
41: * Technically, domains don't need to contain separate {@link
42: * LogicProvider}s, since these operations could be performed by
43: * the domain itself, but typically separate component-like
44: * {@link LogicProvider} classes are used.
45: */
46: public interface Domain {
47:
48: /** returns the domain name, which must be unique */
49: String getDomainName();
50:
51: /** returns the XPlan instance for the domain */
52: XPlan getXPlan();
53:
54: /** returns the Factory for this Domain */
55: Factory getFactory();
56:
57: /** invoke the MessageLogicProviders for this domain */
58: void invokeMessageLogicProviders(DirectiveMessage message);
59:
60: /** invoke the EnvelopeLogicProviders for this domain */
61: void invokeEnvelopeLogicProviders(EnvelopeTuple tuple,
62: boolean isPersistenceEnvelope);
63:
64: /** invoke the RestartLogicProviders for this domain */
65: void invokeRestartLogicProviders(MessageAddress cid);
66:
67: /**
68: * invoke the ABAChangeLogicProviders for this domain.
69: *
70: * @param communities the set of communities with potiential
71: * changes. If null, all communities may have changed.
72: */
73: void invokeABAChangeLogicProviders(Set communities);
74:
75: }
|