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: import org.cougaar.core.mts.MessageAddress;
30: import org.cougaar.core.util.UniqueObject;
31:
32: /**
33: * Interface that describes the methods an object needs to be
34: * transfered from one agent to another using the Transferable Logic
35: * Providers
36: **/
37: public interface Transferable extends Cloneable, UniqueObject {
38: /** A Transferable must be fully cloneable, otherwise unwanted side effects
39: * may show up when object replicas are on agents in the same VM
40: **/
41: Object clone();
42:
43: /**
44: * A "close enough" version of equals() used by the Logic Provider
45: * to find the local version of an object transfered from another agent
46: **/
47: boolean same(Transferable other);
48:
49: /**
50: * Set all relevent parameters to the values in other.
51: * Almost a deep copy.
52: * @param other - must be of same type as this
53: **/
54: void setAll(Transferable other);
55:
56: boolean isFrom(MessageAddress src);
57:
58: /**
59: * @see #isFrom
60: */
61: MessageAddress getSource();
62: }
|