com.sap.ip.me.api.pios.scanner
Class ScannerParameters

java.lang.Object
  extended bycom.sap.ip.me.api.pios.connection.ConnectionParameters
      extended bycom.sap.ip.me.api.pios.scanner.ScannerParameters

public final class ScannerParameters
extends ConnectionParameters

This class represents the scanner parameters required to open a scanner connection. Use a ScannerParameters class instance as a parameter to the open method of the Connector to create a scanner connection.

Example: Set scanner parameters and open a scanner connection.
 
 
 	Connector connector = Connector.getInstance();
 			
 	DriverInfo[] scanners = connector.listDrivers(ConnectionType.SCANNER);
 			
 	ScannerParameters parameters = new ScannerParameters(scanners[0]);
 
 	parameters.setMode(ScannerParameters.SCAN_AWARE);
 			
 	ScannerConnection scanner = (ScannerConnection)connector.open(parameters); 

 
 

Since:
MI 2.5
Author:
Abaco
See Also:
ConnectionParameters, DriverInfo, Enumeration, ScannerConnection

Field Summary
static int SCAN_AWARE
          Constant to indicate scanning aware mode.
static int WEDGE
          Constant to indicate scanner wedge mode.
 
Constructor Summary
ScannerParameters(DriverInfo info)
          Creates a new ScannerParameters object given the driver info assuming the aware mode.
 
Method Summary
 int getMode()
          Returns the scanner connection mode.
 void setMode(int mode)
          Sets the scanner connection mode.
 
Methods inherited from class com.sap.ip.me.api.pios.connection.ConnectionParameters
getConnection, getDriver
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SCAN_AWARE

public static final int SCAN_AWARE
Constant to indicate scanning aware mode. This is the default option.

See Also:
Constant Field Values

WEDGE

public static final int WEDGE
Constant to indicate scanner wedge mode.

See Also:
Constant Field Values
Constructor Detail

ScannerParameters

public ScannerParameters(DriverInfo info)
Creates a new ScannerParameters object given the driver info assuming the aware mode.

Parameters:
info - the driver information object
See Also:
DriverInfo
Method Detail

getMode

public int getMode()
Returns the scanner connection mode.

Returns:
The scanner connection mode.

setMode

public void setMode(int mode)
Sets the scanner connection mode.

Parameters:
mode - the scanner connection mode


Copyright © 2005 SAP AG. All Rights Reserved.