org.apache.beehive.controls.system.ejb.EntityEJBControl Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* $Header:$
*/
package org.apache.beehive.controls.system.ejb;
import org.apache.beehive.controls.api.bean.ControlInterface;
/**
* As part of the EJB control, this interface simplifies access to
* entity Enterprise JavaBeans (EJBs). You do not need to call
* methods of this interface.
*
* The EJB control is actually made up of two main interfaces,
* one for access to entity EJBs
* and another for access to session EJBs. The presence of these
* two interfaces is invisible when you use the EJB control; their
* methods are called behind the scenes.
*
* Typically, you use the EJB control by adding the control to
* a component design (such as a web service or pageflow design),
* then calling the methods it provides. Those methods are not
* exposed by these control interfaces, but rather
* are extensions of the EJB itself that are generated when you add
* the EJB control.
*
* For more information about using the EJB control, see
* EJB Control.
*/
@ControlInterface (defaultBinding="org.apache.beehive.controls.system.ejb.EntityEJBControlImpl")
public interface EntityEJBControl
extends EJBControl
{
/**
* Supports iteration through a Collection of entity bean instances
* returned by a multi-select finder method. This method selects
* the next bean instance in the collection as the internal control
* instance, and returns the bean instance. The method will return
* null if no additional instances remain to be processed.
*
* @return The next bean instance if any remain; otherwise, null.
*/
public Object getEJBNextBeanInstance();
}