IInputAdapter.java

/* ====================================================================
 * Limited Evaluation License:
 *
 * This software is open source, but licensed. The license with this package
 * is an evaluation license, which may not be used for productive systems. If
 * you want a full license, please contact us.
 *
 * The exclusive owner of this work is the OpenRate project.
 * This work, including all associated documents and components
 * is Copyright of the OpenRate project 2006-2015.
 *
 * The following restrictions apply unless they are expressly relaxed in a
 * contractual agreement between the license holder or one of its officially
 * assigned agents and you or your organisation:
 *
 * 1) This work may not be disclosed, either in full or in part, in any form
 *    electronic or physical, to any third party. This includes both in the
 *    form of source code and compiled modules.
 * 2) This work contains trade secrets in the form of architecture, algorithms
 *    methods and technologies. These trade secrets may not be disclosed to
 *    third parties in any form, either directly or in summary or paraphrased
 *    form, nor may these trade secrets be used to construct products of a
 *    similar or competing nature either by you or third parties.
 * 3) This work may not be included in full or in part in any application.
 * 4) You may not remove or alter any proprietary legends or notices contained
 *    in or on this work.
 * 5) This software may not be reverse-engineered or otherwise decompiled, if
 *    you received this work in a compiled form.
 * 6) This work is licensed, not sold. Possession of this software does not
 *    imply or grant any right to you.
 * 7) You agree to disclose any changes to this work to the copyright holder
 *    and that the copyright holder may include any such changes at its own
 *    discretion into the work
 * 8) You agree not to derive other works from the trade secrets in this work,
 *    and that any such derivation may make you liable to pay damages to the
 *    copyright holder
 * 9) You agree to use this software exclusively for evaluation purposes, and
 *    that you shall not use this software to derive commercial profit or
 *    support your business or personal activities.
 *
 * This software is provided "as is" and any expressed or impled warranties,
 * including, but not limited to, the impled warranties of merchantability
 * and fitness for a particular purpose are disclaimed. In no event shall
 * The OpenRate Project or its officially assigned agents be liable to any
 * direct, indirect, incidental, special, exemplary, or consequential damages
 * (including but not limited to, procurement of substitute goods or services;
 * Loss of use, data, or profits; or any business interruption) however caused
 * and on theory of liability, whether in contract, strict liability, or tort
 * (including negligence or otherwise) arising in any way out of the use of
 * this software, even if advised of the possibility of such damage.
 * This software contains portions by The Apache Software Foundation, Robert
 * Half International.
 * ====================================================================
 */
package OpenRate.adapter;

import OpenRate.IPipeline;
import OpenRate.buffer.IConsumer;
import OpenRate.exception.ProcessingException;

/**
 * The IInputAdapter is the interface responsible for selecting a set of work
 * from an external data source for processing and pushing it into the IBuffer
 * for processing.
 */
public interface IInputAdapter
        extends IAdapter {

  /**
   * Send a set of records requiring processing to the pipeline. The collection
   * should contain objects of type IRecord.
   *
   * @param validBuffer The buffer that will receive the pushed records
   * @return The number of records pushed
   * @throws OpenRate.exception.ProcessingException
   */
  public int push(IConsumer validBuffer)
          throws ProcessingException;

  /**
   * Sets the buffer that will receive the pushed batch records
   *
   * @param ch The receiving buffer
   */
  public void setBatchOutboundValidBuffer(IConsumer ch);

  /**
   * Gets the buffer that will receive the pushed batch records
   *
   * @return The consumer output FIFO
   */
  public IConsumer getBatchOutboundValidBuffer();

  /**
   * return the symbolic name
   *
   * @return The current module symbolic name
   */
  public String getSymbolicName();

  /**
   * set the symbolic name
   *
   * @param name The symbolic name to set
   */
  public void setSymbolicName(String name);

  /**
   * Set the pipeline reference so the input adapter can control the scheduler
   *
   * @param pipeline the Pipeline to set
   */
  public void setPipeline(IPipeline pipeline);

  /**
   * @return the pipeline
   */
  public IPipeline getPipeline();
}