01: /*
02: * <copyright>
03: *
04: * Copyright 2000-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.tools.csmart.recipe;
28:
29: import org.cougaar.tools.csmart.core.property.ModifiableComponent;
30: import org.cougaar.tools.csmart.society.AgentComponent;
31:
32: /**
33: * Parent interface for all Recipes to a CSMART system.
34: * Recipes may have Agents, and may need to be able to write
35: * out information in the various Nodes. These interfaces are
36: * exposed.
37: */
38: public interface RecipeComponent extends ModifiableComponent {
39:
40: String CLASS_NAME_PROP = "recipe_class_name";
41: String RECIPE_QUERY_FILE = "recipeQueries.q";
42:
43: String getRecipeName();
44:
45: /**
46: * Get the agents, both assigned and unassigned.
47: * @return array of agent components
48: */
49: AgentComponent[] getAgents();
50:
51: /**
52: * Save the recipe to the database.
53: * @return boolean true if save was successful
54: */
55: boolean saveToDatabase();
56:
57: /**
58: * Return true if recipe is different than in the database.
59: * @return boolean true if recipe is different than in database
60: */
61: boolean isModified();
62: }
|