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: * $Header:$
18: */
19: package org.apache.beehive.controls.system.ejb;
20:
21: import org.apache.beehive.controls.api.bean.ControlInterface;
22:
23: /**
24: * As part of the EJB control, this interface simplifies access to
25: * entity Enterprise JavaBeans (EJBs). You do not need to call
26: * methods of this interface.
27: * <br/><br/>
28: * The EJB control is actually made up of two main interfaces,
29: * one for access to entity EJBs
30: * and another for access to session EJBs. The presence of these
31: * two interfaces is invisible when you use the EJB control; their
32: * methods are called behind the scenes.
33: * <br/><br/>
34: * Typically, you use the EJB control by adding the control to
35: * a component design (such as a web service or pageflow design),
36: * then calling the methods it provides. Those methods are not
37: * exposed by these control interfaces, but rather
38: * are extensions of the EJB itself that are generated when you add
39: * the EJB control.
40: * <br/><br/>
41: * For more information about using the EJB control, see
42: * <a href="../../../../guide/controls/ejb/navEJBControl.html">EJB Control</a>.
43: */
44: @ControlInterface(defaultBinding="org.apache.beehive.controls.system.ejb.EntityEJBControlImpl")
45: public interface EntityEJBControl extends EJBControl {
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 getEJBNextBeanInstance();
56: }
|