View Javadoc

1   /*
2    * Copyright 2001,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.commons.scaffold.util;
18  
19  
20  /**
21   * Simple interface to describe public methods on a
22   * business logic object.
23   *
24   * @author Ted Husted
25   * @version $Revision: 155464 $ $Date: 2005-02-26 13:26:54 +0000 (Sat, 26 Feb 2005) $
26   */
27  public interface Executable {
28  
29  // ------------------------------------------------------- Public Methods
30  
31      /**
32       * Perform business logic for this bean, often by passing default
33       * values to the <code>Object execute(Object)</code> signature.
34       * If there is no default, it is recommended that a subclass throw
35       * an UnsupportedOperationException instead.
36       * @exception Throws Exception on any error. A subclass of
37       * ChainedException is recommended.
38       */
39      public Object execute() throws Exception;
40  
41  
42      /**
43       * Perform business logic for this, by retrieving any settings from
44       * the parameter object, and return a result object.
45       * @exception Throws Exception on any error. A subclass of
46       * ChainedException is recommended.
47       */
48      public Object execute(Object parameters) throws Exception;
49  
50  }