jpos.BeltControl112 Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javapos-contracts Show documentation
JavaPOS Contracts Library
There is a newer version: 1.15.2
//////////////////////////////////////////////////////////////////////
//
// The JavaPOS library source code is now under the CPL license, which 
// is an OSS Apache-like license. The complete license is located at:
//    http://www.ibm.com/developerworks/library/os-cpl.html
//
//////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////
//
// This software is provided "AS IS".  The JavaPOS working group (including
// each of the Corporate members, contributors and individuals)  MAKES NO
// REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE SOFTWARE,
// EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
// WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NON-INFRINGEMENT. The JavaPOS working group shall not be liable for
// any damages suffered as a result of using, modifying or distributing this
// software or its derivatives.Permission to use, copy, modify, and distribute
// the software and its documentation for any purpose is hereby granted.
//
// BeltControl112
//
//   Interface definining all new capabilities, properties and
//   methods that are specific to Belt for release 1.12.
//
// Modification history
// ------------------------------------------------------------------
// 2008-Jan-14 JavaPOS Release 1.12                                BS
//   New device category.
// 2010-Mar-16 JavaPOS Release 1.12.4                              BS
//   Corrected return types of getCapSpeedStepsBackward() and
//   getCapSpeedStepsForward(). Was boolean, but should have been
//   int.
//
/////////////////////////////////////////////////////////////////////

package jpos;

import jpos.events.*;

public interface BeltControl112 extends BaseControl
{
  // Capabilities
  public boolean getCapAutoStopBackward() throws JposException;
  public boolean getCapAutoStopBackwardItemCount() throws JposException;
  public boolean getCapAutoStopForward() throws JposException;
  public boolean getCapAutoStopForwardItemCount() throws JposException;
  public boolean getCapCompareFirmwareVersion() throws JposException;
  public boolean getCapLightBarrierBackward() throws JposException;
  public boolean getCapLightBarrierForward() throws JposException;
  public boolean getCapMoveBackward() throws JposException;
  public int     getCapPowerReporting() throws JposException;
  public boolean getCapRealTimeData() throws JposException;
  public boolean getCapSecurityFlapBackward() throws JposException;
  public boolean getCapSecurityFlapForward() throws JposException;
  public int     getCapSpeedStepsBackward() throws JposException;
  public int     getCapSpeedStepsForward() throws JposException;
  public boolean getCapStatisticsReporting() throws JposException;
  public boolean getCapUpdateFirmware() throws JposException;
  public boolean getCapUpdateStatistics() throws JposException;

  // Properties
  public boolean getAutoStopBackward() throws JposException;
  public void    setAutoStopBackward(boolean autoStop) throws JposException;
  public int     getAutoStopBackwardDelayTime() throws JposException;
  public void    setAutoStopBackwardDelayTime(int delayTime) throws JposException;
  public int     getAutoStopBackwardItemCount() throws JposException;
  public boolean getAutoStopForward() throws JposException;
  public void    setAutoStopForward(boolean autoStop) throws JposException;
  public int     getAutoStopForwardDelayTime() throws JposException;
  public void    setAutoStopForwardDelayTime(int delayTime) throws JposException;
  public int     getAutoStopForwardItemCount() throws JposException;
  public boolean getLightBarrierBackwardInterrupted() throws JposException;
  public boolean getLightBarrierForwardInterrupted() throws JposException;
  public int     getMotionStatus() throws JposException;
  public int     getPowerNotify() throws JposException;
  public void    setPowerNotify(int powerNotify) throws JposException;
  public int     getPowerState() throws JposException;
  public boolean getSecurityFlapBackwardOpened() throws JposException;
  public boolean getSecurityFlapForwardOpened() throws JposException;

  // Methods
  public void    adjustItemCount(int direction,
                                 int count)
                     throws JposException;
  public void    compareFirmwareVersion(String firmwareFileName,
                                        int[] result)
                     throws JposException;
  public void    moveBackward(int speed)
                     throws JposException;
  public void    moveForward(int speed)
                     throws JposException;
  public void    resetBelt()
                     throws JposException;
  public void    resetItemCount(int direction)
                     throws JposException;
  public void    resetStatistics(String statisticsBuffer)
                     throws JposException;
  public void    retrieveStatistics(String[] statisticsBuffer)
                     throws JposException;
  public void    stopBelt()
                     throws JposException;
  public void    updateFirmware(String firmwareFileName)
                     throws JposException;
  public void    updateStatistics(String statisticsBuffer)
                     throws JposException;

  // Event listener methods
  public void    addDirectIOListener(DirectIOListener l);
  public void    removeDirectIOListener(DirectIOListener l);
  public void    addStatusUpdateListener(StatusUpdateListener l);
  public void    removeStatusUpdateListener(StatusUpdateListener l);
}