01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.forms.binding;
18:
19: import org.apache.cocoon.forms.binding.library.Library;
20: import org.apache.cocoon.forms.formmodel.Widget;
21:
22: /**
23: * Binding declares the methods to 'bind' (i.e. 'load' and 'save')
24: * information elements from some back-end model (2nd argument) to and from
25: * a existing Cocoon Form Widget.
26: *
27: * @version $Id: Binding.java 450255 2006-09-26 23:48:43Z vgritsenko $
28: */
29: public interface Binding {
30:
31: /**
32: * Sets parent binding.
33: * @param binding Parent of this binding.
34: */
35: void setParent(Binding binding);
36:
37: /**
38: * Gets binding definition id.
39: */
40: String getId();
41:
42: /**
43: * returns the local library for this tree of bindings
44: */
45: Library getEnclosingLibrary();
46:
47: /**
48: * sets the library this binding is a part of
49: */
50: void setEnclosingLibrary(Library lib);
51:
52: /**
53: * checks for deep validity of this binding tree (taking into accound included libraries)
54: */
55: boolean isValid();
56:
57: /**
58: * Gets a binding class.
59: * @param id Id of binding class to get.
60: */
61: Binding getClass(String id);
62:
63: /**
64: * Loads the information-elements from the objModel to the frmModel.
65: *
66: * @param frmModel
67: * @param objModel
68: */
69: void loadFormFromModel(Widget frmModel, Object objModel)
70: throws BindingException;
71:
72: /**
73: * Saves the infortmation-elements to the objModel from the frmModel.
74: * @param frmModel
75: * @param objModel
76: */
77: void saveFormToModel(Widget frmModel, Object objModel)
78: throws BindingException;
79: }
|