001    /*
002     * Copyright 2001,2004 The Apache Software Foundation.
003     * 
004     * Licensed under the Apache License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of 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,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    
017    package org.apache.commons.scaffold.util;
018    
019    
020    /**
021     * Simple interface to describe public methods on a
022     * business logic object.
023     *
024     * @author Ted Husted
025     * @version $Revision: 155464 $ $Date: 2005-02-26 13:26:54 +0000 (Sat, 26 Feb 2005) $
026     */
027    public interface Executable {
028    
029    // ------------------------------------------------------- Public Methods
030    
031        /**
032         * Perform business logic for this bean, often by passing default
033         * values to the <code>Object execute(Object)</code> signature.
034         * If there is no default, it is recommended that a subclass throw
035         * an UnsupportedOperationException instead.
036         * @exception Throws Exception on any error. A subclass of
037         * ChainedException is recommended.
038         */
039        public Object execute() throws Exception;
040    
041    
042        /**
043         * Perform business logic for this, by retrieving any settings from
044         * the parameter object, and return a result object.
045         * @exception Throws Exception on any error. A subclass of
046         * ChainedException is recommended.
047         */
048        public Object execute(Object parameters) throws Exception;
049    
050    }