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   * A business service facade designed to be invoked 
22   * through a <code>process</code> method.
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 BizService {
28  
29      /**
30       * Perform the business logic for this service, by retrieving any 
31       * runtime properties from the business request 
32       * [<code>org.apache.commons.util.BizRequest</code>]
33       * and providing the result as a business response 
34       * [<code>org.apache.commons.util.BizResponse</code>]. 
35       * <p>
36       * The business service may often be a facade that is used to 
37       * connect to other services. 
38       *
39       * @exception Throws Exception on any error. 
40       * A <code>ChainedException</code> is recommended.. 
41       * @param request The bean containing the runtime parameters for 
42       * this service.
43  	 * @author Ted Husted
44  	 * @author Nationwide Insurance Company
45  	 * @version $Revision: 155464 $ $Date: 2005-02-26 13:26:54 +0000 (Sat, 26 Feb 2005) $
46       */
47       public BizResponse process(BizRequest request) throws Exception;
48  
49  } // end BizService