01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/metaobj/tags/sakai_2-4-1/metaobj-util/tool-lib/src/java/org/sakaiproject/metaobj/utils/mvc/intf/LoadObjectController.java $
03: * $Id: LoadObjectController.java 14230 2006-09-05 18:02:51Z chmaurer@iupui.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.metaobj.utils.mvc.intf;
21:
22: import java.util.Map;
23:
24: /**
25: * This control is useful for loading data into a backing object from a backing store.
26: * This is typically necessary in a controller that is editing backend data.
27: * To use simply implement fillBackingObject to oad data into the incomingModel.
28: * By the time fillBackingObject is called the system
29: * has already created the backing object and bound the request params into it.
30: * This means any id's or other information you need to lookup the data will be available in
31: * the incomingModel.
32: *
33: * @author John Ellis (john.ellis@rsmart.com)
34: * @author John Bush (john.bush@rsmart.com)
35: */
36: public interface LoadObjectController extends Controller {
37:
38: public Object fillBackingObject(Object incomingModel, Map request,
39: Map session, Map application) throws Exception;
40:
41: }
|