01: /*
02: * <copyright>
03: *
04: * Copyright 2001-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.service;
28:
29: import org.cougaar.core.adaptivity.OMCRangeList;
30: import org.cougaar.core.component.Service;
31:
32: /**
33: * This service can be used to view and modify persistence
34: * settings.
35: */
36: public interface PersistenceControlService extends Service {
37: /**
38: * Gets the names of all controls (operating modes). These are
39: * controls over persistence as a whole, not media-specific.
40: * @return an array of all control names
41: */
42: String[] getControlNames();
43:
44: /**
45: * Gets the (allowed) values of a given control. Values used to
46: * set a control must be in the ranges specified by the return.
47: * @return a list of ranges of values that are allowed for the
48: * named control.
49: * @param controlName the name of a persistence-wide control
50: */
51: OMCRangeList getControlValues(String controlName);
52:
53: /**
54: * Sets the value for the named control. The value must be in the
55: * list or ranges returned by {@link #getControlValues}.
56: * @param controlName the name of the control to set.
57: * @param newValue the new value for the control. Must be in the
58: * allowed ranges.
59: */
60: void setControlValue(String controlName, Comparable newValue);
61:
62: /**
63: * Gets the names of the installed media plugins.
64: * @return an array of the names of the installed media plugins.
65: */
66: String[] getMediaNames();
67:
68: /**
69: * Gets the names of the controls for the named media (plugin).
70: * @return an array of all control names for the given media.
71: * @param mediaName the name of the media.
72: */
73: String[] getMediaControlNames(String mediaName);
74:
75: /**
76: * Gets the allowed values of then named control for the named
77: * media plugin. Values used to set a control must be in the
78: * ranges specified by the return.
79: * @return a list of ranges of values that are allowed for the
80: * named control.
81: * @param mediaName the name of the media having the control
82: * @param controlName the name of a media-specific control
83: * @return a list of the allowed value ranges.
84: */
85: OMCRangeList getMediaControlValues(String mediaName,
86: String controlName);
87:
88: /**
89: * Sets the value for the named control for the named media
90: * plugin. The value must be in the list or ranges returned by
91: * {@link #getMediaControlValues}.
92: * @param mediaName the name of the media having the control
93: * @param controlName the name of the control to set.
94: * @param newValue the new value for the control. Must be in the
95: * allowed ranges.
96: */
97: void setMediaControlValue(String mediaName, String controlName,
98: Comparable newValue);
99: }
|