Kofax Mobile SDK API Reference
Classes | Public Member Functions | List of all members
MicrLine Class Reference

This class represents the MICR line itself. More...

Classes

enum  CheckType
 An enum which identifies the type of check. More...
 

Public Member Functions

 MicrLine ()
 
boolean getValueSet ()
 
String getAuxiliaryOnUs ()
 
void setAuxiliaryOnUs (String auxiliaryOnUs)
 
String getEPC ()
 
void setEPC (String epc)
 
String getTransitNumber ()
 
void setTransitNumber (String transitNumber)
 
String getOnUs ()
 Returns the On-Us field. More...
 
void setOnUs (String onUs)
 
String getOnUs1 ()
 
void setOnUs1 (String onUs1)
 
String getOnUs2 ()
 
void setOnUs2 (String onUs2)
 
String getAmount ()
 
void setAmount (String amount)
 
void setCheckType (CheckType checkType)
 
CheckType getCheckType ()
 

Detailed Description

This class represents the MICR line itself.

This class contains the following raw properties of the MICR line: AuxiliaryOnUs " When this field is present (it is usually only present on business checks) it usually contains the check number. EPC - This field is used for "specific purposes" and cannot be used without written authorization from the ASC X9B. RoutingNumber - officially this field is called the transit field, but it is only used for the routing number On-Us1, On-Us2 - The On-Us field is actually two fields in one that are separated by an On-Us symbol. The numbers to the left of the On-Us symbol (what we are calling On-Us1) contains the Account Number, the value to the right of the On-Us symbol (what we are calling On-Us2) is for "special bank use". In a personal check, the value to the right of On-Us contains the Check Number Amount - If present, this field typically contains the amount of the check.

Constructor & Destructor Documentation

MicrLine ( )

Member Function Documentation

String getAmount ( )

The amount field contains the check amount. This is generally not present unless the check has been processed by a bank. This property is empty if the field is not present.

Returns
String.
String getAuxiliaryOnUs ( )

AuxiliaryOnUs contains the contents of the Auxiliary On-Us field in the MICR. It usually contains the check number. It is generally not present on personal checks. This property is empty if this field is not present.

Returns
String.
CheckType getCheckType ( )

Returns the check type - personal or business.

Returns
CheckType
String getEPC ( )

EPC contains the contents of the External Processing Code. It is a one character field, and is usually not present in the MICR. This property is empty if the field is not present.

Returns
String.
String getOnUs ( )

Returns the On-Us field.

Returns
the On-Us field
See also
getOnUs1()
getOnUs2()
String getOnUs1 ( )

OnUS1 contains the contents of the first portion of the On-Us field in the MICR. It generally contains the account number.

Returns
String.
String getOnUs2 ( )

OnUS2 contains the contents of the second portion of the On-Us MICR field. If present, it contains the check number. This property is empty if the field is not present.

Returns
String.
String getTransitNumber ( )

Officially this field is called the transit field, but it is only used for the routing number. This field must be present in the MICR.

Returns
String.
boolean getValueSet ( )

At least one value has been set in the object.

Returns
void setAmount ( String  amount)

Setter for the Amount property.

Parameters
amount
void setAuxiliaryOnUs ( String  auxiliaryOnUs)

Setter for the AuxiliaryOnUs property.

Parameters
auxiliaryOnUs
void setCheckType ( CheckType  checkType)

Setter for CheckType property.

Parameters
checkType
void setEPC ( String  epc)

Setter for the EPC property.

Parameters
epc
void setOnUs ( String  onUs)

Setter for the On-Us field.

Parameters
onUsthe On-Us field
See also
setOnUs1(String)
setOnUs2(String)
void setOnUs1 ( String  onUs1)

Setter for the OnUs1 property.

Parameters
onUs1
void setOnUs2 ( String  onUs2)

Setter for the OnUs2 property.

Parameters
onUs2
void setTransitNumber ( String  transitNumber)

Setter for the transit number property.

Parameters
transitNumber

The documentation for this class was generated from the following file:
Untitled Document © 2018 Kofax, Inc. All rights reserved. Use is subject to license terms.