001    /*
002     * Copyright 2002-2004 the original author or authors.
003     * 
004     * Licensed under the Apache License, Version 2.0 (the "License"); you may not
005     * use this file except in compliance with the License. You may obtain a copy of
006     * the License at
007     * 
008     * http://www.apache.org/licenses/LICENSE-2.0
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
012     * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
013     * License for the specific language governing permissions and limitations under
014     * the License.
015     */
016    package org.springframework.richclient.core;
017    
018    /**
019     * Interface to be implemented by objects that can be enabled or disabled. For example, these 
020     * objects will typically be user interface controls that the application will want 
021     * to disable in certain contexts. 
022     * 
023     * @author Keith Donald
024     */
025    public interface Guarded {
026        
027        /**
028         * Indicates if the object is in an enabled state.
029         * @return {@true} if the object is in an enabled state, {@false} otherwise.
030         */
031        public boolean isEnabled();
032    
033        /**
034         * Sets the enabled state of the object.
035         * @param enabled {@code true} to enable the object, {@code false} to disable it. 
036         */
037        public void setEnabled(boolean enabled);
038        
039    }