KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > beehive > controls > system > ejb > EntityEJBControl


1 /*
2  * Copyright 2005 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  * $Header:$
17  */
18 package org.apache.beehive.controls.system.ejb;
19
20 import org.apache.beehive.controls.api.bean.ControlInterface;
21
22 /**
23  * As part of the EJB control, this interface simplifies access to
24  * entity Enterprise JavaBeans (EJBs). You do not need to call
25  * methods of this interface.
26  * <br/><br/>
27  * The EJB control is actually made up of two main interfaces,
28  * one for access to entity EJBs
29  * and another for access to session EJBs. The presence of these
30  * two interfaces is invisible when you use the EJB control; their
31  * methods are called behind the scenes.
32  * <br/><br/>
33  * Typically, you use the EJB control by adding the control to
34  * a component design (such as a web service or pageflow design),
35  * then calling the methods it provides. Those methods are not
36  * exposed by these control interfaces, but rather
37  * are extensions of the EJB itself that are generated when you add
38  * the EJB control.
39  * <br/><br/>
40  * For more information about using the EJB control, see
41  * <a HREF="../../../../guide/controls/ejb/navEJBControl.html">EJB Control</a>.
42  */
43 @ControlInterface (defaultBinding="org.apache.beehive.controls.system.ejb.EntityEJBControlImpl")
44 public interface EntityEJBControl extends EJBControl
45 {
46     /**
47      * Supports iteration through a Collection of entity bean instances
48      * returned by a multi-select finder method. This method selects
49      * the next bean instance in the collection as the internal control
50      * instance, and returns the bean instance. The method will return
51      * null if no additional instances remain to be processed.
52      *
53      * @return The next bean instance if any remain; otherwise, null.
54      */
55     public Object JavaDoc getEJBNextBeanInstance();
56 }
57
Popular Tags