001: /*
002: * $Header: /export/home/cvsroot/MyPersonalizerRepository/MyPersonalizer/Subsystems/Kernel/Sources/es/udc/mypersonalizer/kernel/model/editors/ServiceButtonsStateEditor.java,v 1.1.1.1 2004/03/25 12:08:37 fbellas Exp $
003: * $Revision: 1.1.1.1 $
004: * $Date: 2004/03/25 12:08:37 $
005: *
006: * =============================================================================
007: *
008: * Copyright (c) 2003, The MyPersonalizer Development Group
009: * (http://www.tic.udc.es/~fbellas/mypersonalizer/index.html) at
010: * University Of A Coruna
011: * All rights reserved.
012: *
013: * Redistribution and use in source and binary forms, with or without
014: * modification, are permitted provided that the following conditions are met:
015: *
016: * - Redistributions of source code must retain the above copyright notice,
017: * this list of conditions and the following disclaimer.
018: *
019: * - Redistributions in binary form must reproduce the above copyright notice,
020: * this list of conditions and the following disclaimer in the documentation
021: * and/or other materials provided with the distribution.
022: *
023: * - Neither the name of the University Of A Coruna nor the names of its
024: * contributors may be used to endorse or promote products derived from
025: * this software without specific prior written permission.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
028: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
029: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
030: * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
031: * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
032: * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
033: * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
034: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
035: * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
036: * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
037: * POSSIBILITY OF SUCH DAMAGE.
038: *
039: */
040:
041: package es.udc.mypersonalizer.kernel.model.editors;
042:
043: import es.udc.mypersonalizer.kernel.model.properties.Property;
044: import es.udc.mypersonalizer.kernel.util.exceptions.InternalErrorException;
045: import java.util.*;
046:
047: /**
048: * This editor accesses the information stored in a ServiceButtonsState
049: * property, knowing the internals of its structure and hiding them to the
050: * object which might use it.
051: *
052: * @author Daniel Fernandez
053: * @since 1.0
054: */
055: public interface ServiceButtonsStateEditor {
056:
057: /**
058: * Sets the property on which the editor will work.
059: *
060: * @param property the property.
061: */
062: public void setProperty(Property property);
063:
064: /**
065: * Returns the Map with the buttons states. This Map will be indexed by
066: * button name, and have Integer objects as values, being these the states
067: * which may correspond to each button.
068: *
069: * @throws InternalErrorException if any fatal error happens.
070: * @return A map with all button's state (as an <code>Integer</code>)
071: * indexed by name.
072: */
073: public Map getButtonsState() throws InternalErrorException;
074:
075: /**
076: * Sets the new states for the buttons as a Map, being this indexed by the
077: * button name (a String) and having as values Integer objects representing
078: * the buttons' states.
079: *
080: * @param buttonsState the Map with the new buttons' states.
081: * @throws InternalErrorException if any fatal error happens.
082: */
083: public void setButtonsState(Map buttonsState)
084: throws InternalErrorException;
085:
086: /**
087: * Returns the state for a particular button, knowing its name.
088: *
089: * @return an Integer being the state of the button with the given name.
090: * @param buttonName the name of the button.
091: * @throws InternalErrorException if any fatal error happens.
092: */
093: public Integer getButtonState(String buttonName)
094: throws InternalErrorException;
095:
096: /**
097: * Sets the new state for a particular button identified by its name.
098: *
099: * @param buttonName the name of the button which state to change.
100: * @param state the new state for this button.
101: * @throws InternalErrorException if any fatal error happens.
102: */
103: public void setButtonState(String buttonName, Integer state)
104: throws InternalErrorException;
105:
106: }
|