Atalasoft MobileImage API Reference
Instance Methods | List of all members
kfxKUTMicrParser Class Reference

#import <kfxKUTMicrParser.h>

Inheritance diagram for kfxKUTMicrParser:

Instance Methods

(instancetype) - initWithMicr:
 Initializes a new object using the specified MICR string. More...
 
(void) - parseMicr:
 Parses an input MICR string and sets the object properties with the MICR data. More...
 
(NSString *) - getAccountNumber
 Returns the account number. More...
 
(NSString *) - getCheckNumber
 Returns the check number. More...
 
(NSString *) - getTransitNumber
 Returns the transit number. More...
 
(KUTCheckType) - getCheckType
 Returns the type of check. More...
 
(BOOL) - getValueSet
 Returns a value indicating if any micrLine fields have been set. More...
 
(kfxKUTMicrLine *) - getMicrLine
 Returns the micrline object. More...
 
(BOOL) - isMicrValid
 Returns validity of parsed micr line. More...
 

Method Documentation

- (NSString *) getAccountNumber

Returns the account number.

This method returns the onUs string when this method is called.

- (NSString *) getCheckNumber

Returns the check number.

This method chooses either auxiliaryOnUs or onUs2 to return as the check number. The auxiliaryOnUs string is returned if set. Otherwise onUs2 is returned.

- (KUTCheckType) getCheckType

Returns the type of check.

This method returns an enum indicating whether the check was a business or personal check..

- (kfxKUTMicrLine *) getMicrLine

Returns the micrline object.

This method returns the associated instance of the kfxKUTMicrLine object.

- (NSString *) getTransitNumber

Returns the transit number.

This method returns the transit number from the parsed Micr Line.

- (BOOL) getValueSet

Returns a value indicating if any micrLine fields have been set.

This method returns a Boolean value of YES if any of the micrLine fields have been set. If NO, the micrLine string could not be extracted and parsed.

- (instancetype) initWithMicr: (NSString *)  micrString

Initializes a new object using the specified MICR string.

This method is provided to instantiate this object and decode the provided MICR string. An example follows:

NSArray *fieldTypeArray = nil;
kfxKUTMicrParser *theMicrData = nil;
theMicrData = [[kfxKUTMicrParser alloc] initWithMicr: micrString];
- (BOOL) isMicrValid

Returns validity of parsed micr line.

This method returns a flag indicating the provided MICR string was valid.

- (void) parseMicr: (NSString *)  micrString

Parses an input MICR string and sets the object properties with the MICR data.

This method parses the provided MICR string and sets the object properties with the components of the MICR.


The documentation for this class was generated from the following file:
Untitled Document © 2016 Atalasoft, Inc., 116 Pleasant St, Suite 321, Easthampton, MA 01027, U.S.A. All rights reserved. Use is subject to license terms.