kfxKUTErrorInfo.h

Go to the documentation of this file.

//  API Reference
//
//  kfxErrorInfo.h
//  Utilties
//
//  Copyright (c) 2012 - 2017 Kofax. Use of this code is with permission pursuant to Kofax license terms.
//
#ifndef kfxKUTErrorInfoIncluded
#define kfxKUTErrorInfoIncluded 1

#import <Foundation/Foundation.h>

#define KMC_GN_BASE                 0x1000
#define KMC_UI_BASE                 0x2000
#define KMC_LO_BASE                 0x3000
#define KMC_CD_BASE                 0x4000
#define KMC_IP_BASE                 0x5000
#define KMC_ED_BASE                 0x6000
#define KMC_UT_BASE                 0x7000
#define KMC_EX_BASE                 0x8000

// 0x9000 to 0xAFFF open

#define KMC_BC_BASE                 0xB000
#define KMC_CL_BASE                 0xC000

#define KMC_EV_BASE                 0xE000


#define KMC_SUCCESS  0

#define KFX_ERROR_DOMAIN @"com.kofax.mobilesdk"



typedef enum kfxErrorGeneral {
    KGN_BASE = KMC_GN_BASE,
    
    KMC_GN_FILE_NOT_FOUND,
    KMC_GN_OUT_OF_MEMORY,
    KMC_GN_UNKNOWN_ERROR,
    KMC_GN_PARAM_NEGATIVE,
    KMC_GN_UNSUPPORTED_OPERATION,
    
    KMC_GN_LAST,
} KFX_ERROR_GENERAL;


typedef enum kfxKedErrorEngineData {
    KED_BASE = KMC_ED_BASE,
    KMC_ED_FILEPATH, //  The image object is missing a valid file path. RCA: Set the file path before calling write or read file methods.
    KMC_ED_MIMETYPE, //  The image object has an invalid mimetype setting. RCA: Set a valid mimetype before calling the write image method.
    KMC_ED_NOIMAGE,  //  No image object is specified for writing. RCA: Setup a valid image buffer for use with writing the image.
    KMC_ED_IMAGELEAK,  // The image buffer is not nil, therefore the read operation would create a memory leak. RCA: Be sure to free the memory before reading in a new image.
    KMC_ED_INVALID_COLOR, // The output color depth is not 1,8 or 24,
    KMC_ED_NONEXISTENT_FILE,  // the file does not exist
    KMC_ED_FILE_NOT_DELETABLE,
    KMC_ED_FILE_STILL_REMAINS, // 8
    KMC_ED_MISSING_FILE_EXTENSION,
    KMC_ED_MIMETYPE_MISMATCH,
    KMC_ED_JPEG_BITDEPTH,
    KMC_ED_FILE_EXISTS,
    
    KMC_ED_IMAGE_IS_SCALED, // D          // not ios
    KMC_ED_OBJECT_REP_BITMAP_MISMATCH, // E
    KMC_ED_OBJECT_REP_FILE_MISMATCH,
    
    KMC_ED_ILLEGAL_STATE, // 0x10, 16
    KMC_ED_INVALID_ISO_DATE_TIME_FORMAT,  // not ios
    KMC_ED_INVALID_JPEG_QUALITY_VALUE,
    KMC_ED_BITMAP_WRITE_TO_FILE_FAILED,   // not ios
    
    KMC_ED_INVALID_DPI, // 20
    KMC_ED_ALREADY_CLEAR, // 21
    KMC_ED_ALTERNATE_FILEIO_ENGINE, //22

    KMC_ED_BITMAP_READ_FROM_FILE_FAILED,
    KMC_ED_PNG_FILE_WRITE,
    KMC_ED_NO_MEMORY_FOR_METADATA,
    KMC_ED_FILE_EXTENSION,
    KMC_ED_INVALID_ROTATION,//27
    KMC_ED_INVALID_BITDEPTH,
    KMC_ED_INVALID_TETRAGON_CORNERS,
    
    KMC_ED_IMAGE_COLOR_SPACE, // 30
    KMC_ED_IMAGE_CONTEXT, //31
    KMC_ED_IMAGE_WRITTEN_IS_NOT_BITONAL, //32
    KMC_ED_IMAGE_WRITTEN_IS_NOT_GRAY,
    KMC_ED_INVALID_CROP, // 34

    KMC_ED_IMAGE_INVALID,  //35
    
    KMC_ED_UNRECOGNIZED_MIME_TYPE, // The Mime type of the specified image file path cannot be determined, or is unsupported.
    //Make sure the image file specified is one of the supported Mime types:  TIFF, JPEG, PNG.
    
    KMC_ED_BITMAP_DIMENSIONS_IMMUTABLE, // The bitmap dimensions (width, height) cannot be set because this Image object is already represented by an immutable bitmap.
    //Make sure the Image object representation is either IMAGE_REP_FILE or IMAGE_REP_UNKNOWN before attempting to specify bitmap dimensions.
    
    
    KMC_ED_BITMAP_DIMENSIONS_NO_UPSCALE, // The bitmap dimensions (width, height) cannot be set larger than the original file-based representation of this Image object.
    //Make sure the bitmap dimensions specified are smaller than those of the original file-based image representation.  Only bitmap downscaling is supported.
    
    KMC_ED_IMAGE_FILE_DIMENSIONS_ERROR, // 38: The image file dimensions (width, height) cannot be determined.
    //There was an internal SDK problem attempting to read the image dimensions from the image file path contained in the Image object.
    
    KMC_ED_IMAGE_INVALID_SCALING_FACTOR, // 39: The scaling factor selected for this image object is invalid.
    //    The scaling factor supported for each image object is between 0.1 and 1.0.  A scaling factor of 1.0 means no scaling is performed.
    
    KMC_ED_IMAGE_PERFECTION_PROFILE_EMPTY, // 40: The ImagePerfectionProfile contains no image processing operations.
            //Specify some image processing operations in the ipOperations property or ipOperationsFilePath property of the ImagePerfectionProfile.

    KMC_ED_OBJECT_REP_NO_BITMAP, // 41: The current image representation does not include a bitmap.
    //the operation requested requires an image representation which includes a bitmap.  The image representation should be either IMAGE_REP_BITMAP or IMAGE_REP_BOTH
    
    KMC_ED_BUFFER_EXISTS, // 42: The file buffer for writing already exists, and the buffer contents would be lost.
    // Make sure you clear the file buffer before writing with the same bitmap to prevent data loss.
    
    KMC_ED_BUFFER, // 43: The image object is missing a valid file buffer.
    // Write the bitmap to a file buffer before calling the read file from buffer method.
    
    KMC_ED_BUFFER_ALREADY_CLEARED, // 44: The file buffer has already been cleared.
    // This warning indicates you did not need to clear the file buffer when it was already cleared.

    
    KMC_ED_OBJECT_REP_MISMATCH, // 45 new for image write to buffer.
    KMC_ED_ALREADY_BUFFERED,    // 46 new for buffered files.
    KMC_ED_DELETE_BUFFERED_FILE, //47 new for buffered file
    KMC_ED_NO_MEMORY_FOR_BUFFERED_FILE, // 48 for write to buffer.
    KMC_ED_BUFFERED_READ_FAILED,  // 49 new for read from buffer for PNG
    KMC_ED_NO_BUFFERED_IMAGE,        // 50 no buffered image to read from.
    KMC_ED_INVALID_FOR_OBJECT_REP,  // 51
    KMC_ED_NONEXISTENT_LOAD_SETTINGS_FILE, // 52
    KMC_ED_RESTRICTION_MIMETYPE_MISMATCH,  // 53  invalid mine type for ANSI X9 tiff output
    KMC_ED_RESTRICTION_INVALID_COLOR,      // 54  invalid output color setting for ANSI X9 tiff output
    KMC_ED_RESTRICTION_INVALID_DPI,        // 55  invalid dpi for ANSI X9 tiff output
    
    KMC_ED_INVALID_DOCUMENT_DIMENSIONS, //56
    
    KMC_ED_LAST
} KFX_ERROR_ENGINE_DATA;


typedef enum kfxErrorUIControls {
    KMC_UI_UNKNOWN = KMC_UI_BASE,
    
    KMC_UI_FLASH_AUTO_NOT_SUPPORTED,
    KMC_UI_FLASH_ON_NOT_SUPPORTED,
    KMC_UI_FLASH_OFF_NOT_SUPPORTED,
    KMC_UI_SCALING_FACTOR,
    KMC_UI_INVALID_THRESHOLD_ARGUMENT,
    KMC_UI_INVALID_DECLINATION_ARGUMENT,
    KMC_UI_INVALID_STABILITY_DELAY_ARGUMENT,
    KMC_UI_IMAGE_NULL,
    KMC_UI_CAMERA_ALREADY_OPEN,
    KMC_UI_CAMERA_OPERATION_FAILURE,
    KMC_UI_CAMERA_LOCK_ACQUIRE_FAILURE,
    KMC_UI_INVALID_AXIS_THRESHOLD_ARGUMENT,
    KMC_UI_INVALID_PAGE_THRESHOLD_ARGUMENT,
    KMC_UI_FOCUS_AREA_NOT_SUPPORTED,
    KMC_UI_FOCUS_AREA_COUNT,
    KMC_UI_FOCUS_AREA_EMPTY,
    KMC_UI_FLASH_TORCH_NOT_SUPPORTED,
    KMC_UI_INVALID_PADDING_PERCENTAGE_ARGUMENT,
    KMC_UI_INVALID_ASPECT_RATIO_ARGUMENT,
    KMC_UI_INVALID_BORDER_THICKNESS_ARGUMENT,
    KMC_UI_INVALID_WIDTH_ARGUMENT,
    KMC_UI_INVALID_HEIGHT_ARGUMENT,
    KMC_UI_INVALID_LEVEL_THRESHOLD, // The level threshold for pitch or roll is invalid for the requested operation.
    KMC_UI_TORCH_UNAVAILABLE, // The torch is unsupported or unavailable.
    KMC_UI_INVALID_IMAGES, //Invalid images to remove glare
    KMC_UI_INVALID_IMAGES_COUNT, //Invalid number of images to remove glare
    KMC_UI_LAST
} KFX_ERROR_UICONTROLS_ERRORS;


typedef enum kfxErrorLogistics {

    KLO_BASE = KMC_LO_BASE,
    KMC_LO_INVALID_SERVER_URL,  // 1
    KMC_LO_SERVER_URL_NOT_SET,  // the URL is nil
    KMC_LO_USERNAME_NOT_SET,    // 3, user name or password found nil on login
    KMC_LO_USER_ALREADY_LOGGED_IN, // 4,
    KMC_LO_USER_NOT_LOGGED_IN_ON_LOGOUT, // 5
    KMC_LO_USER_LOGGING_IN_ON_LOGIN,     // 6
    KMC_LO_USER_ALREADY_LOGGED_OUT,      // 7
    KMC_LO_USER_LOGGING_OUT_ON_LOGOUT,   // 8
    KMC_LO_DEVICE_REG_LICENSING_ERROR, // 9
    KMC_LO_SESSION_STATE_BUSY,             // 10
    KMC_LO_USER_LOGIN_ERROR,               // 11

    KMC_LO_PAGE_NOT_FOUND,                 // 12
    KMC_LO_IMAGE_NOT_FOUND,
    
    KMC_LO_DOMAIN,      // domain string found nil on login
    KMC_LO_EMAIL,       // if not demo server, email is nil on login
    KMC_LO_NOT_REGISTERED, // not registered yet
    KMC_LO_REGISTERING,
    KMC_LO_OVERLAPPED_OPERATIONS,
    KMC_LO_INVALID_SESSION_STATE,       // 19
    KMC_LO_LOGIN_NOT_ALLOWED,           // 20
    KMC_LO_NOT_LOGGED_IN, // 21: KMC_LO_NOT_LOGGED_IN: You are not logged in
    //Use the register and then login methods for normal sequences.
    KMC_LO_USER_LOGOUT_ERROR, // 22: An error occurred attempting to logout from the Server.
        //Check  your network connection, and make sure that you are successfully logged in prior to calling the logout() method.
    
    KMC_LO_TASK_LOCK_ACQUIRE_ERROR, // 23: Attempt to acquire a lock for the task associated with this method failed.
            // Internal unexpected error.  No recommendation.
    
    KMC_LO_NO_OPERATION_TO_CANCEL, // 24: There is no currently running operation to cancel.
            //You can only cancel a running operation.
    
    KMC_LO_OPERATION_NOT_CANCELLABLE, // 25: The currently running operation cannot be cancelled.
            //You can only cancel a running operation that supports cancellation.  Check the developer guide to see what operations are cancellable.
    
    KMC_LO_OPERATION_CANCELLED, // 26: The currently running operation was successfully cancelled.
            //The operation has been cancelled, and the SESSION_STATE has returned to the previous state.
    
    KMC_LO_INVALID_DOCUMENT_TYPE_NAME, // 27: The DocumentType name specified is not valid or not available on the Server.
            //Make sure the DocumentType name specified corresponds to a valid DocumentType on the Server.   Check with your Administrator to confirm the DocumentType requested is still available.
    
    KMC_LO_DOWNLOAD_DOCUMENT_FIELDS_ERROR, // 28: An error occurred attempting to download document fields from the Server.
            // Check  your network connection and ask your Administrator to confirm that document fields for the DocumentType requested are still available.
    
    KMC_LO_SUBMIT_PNG,  // 29: when you submit a document that has an image represented by a PNG file mimetype.
    KMC_LO_SUBMIT_BITMAP,   // 30: when someone tries to submit an image of a document when it is a bitmap representation.  The image rep must be FILE or BOTH, and the FILE representation could be FILE_BUFFERED or FILE_STORED.
    
    
    KMC_LO_START_SUBMIT_JOB_ERROR, // 31
      //Msg: KMC_LO_START_SUBMIT_JOB_ERROR:  An error occurred attempting to start a document submission job.
      //Des: Check your network connection and ask your Administrator to confirm that your user credentials are valid.  Make sure that your device is still registered.
    
    KMC_LO_SUBMIT_DOCUMENT_IMAGES_ERROR, // 32:
      // KMC_LO_SUBMIT_DOCUMENT_IMAGES_ERROR:  An error occurred attempting to submit images and fields within a document to the Server.
      //Check your network connection and ask your Administrator to confirm that your user credentials are valid and that your DocumentType is recognized by the Server.
    
    KMC_LO_START_SUBMIT_INVALID_JOB_ID, // 33:
      //KMC_LO_START_SUBMIT_INVALID_JOB_ID:  An invalid or missing job ID was detected while starting a document submission job.
      //Ask your Administrator to confirm that your Server is configured to accept new document submission jobs.
    
    
    KMC_LO_SUBMIT_DOCUMENT_FILEIO_ERROR, //34
      //KMC_LO_SUBMIT_DOCUMENT_FILEIO_ERROR:  While preparing a document for submission, a file I/O error occurred reading an image file in one of the pages.
      // Make sure the image file referenced by the Image object in the Document still exists and your application has appropriate file access permissions.

    KMC_LO_SUBMIT_DOCUMENT_FILE_CLOSE_ERROR, // 35
        // KMC_LO_SUBMIT_DOCUMENT_FILE_CLOSE_ERROR: While preparing a document for submission, a file close error occurred after reading an image file in one of the pages.
        //    Make sure the image file referenced by the Image object in the Document still exists and your application has appropriate file access permissions.
    
    KMC_LO_SUBMIT_DOCUMENT_NO_IMAGE_ERROR, //36
        //    KMC_LO_SUBMIT_DOCUMENT_NO_IMAGE_ERROR: The document to be submitted contains no pages with images.
        //    Make sure each Document  contains at least one page with one image before submitting.
    
    KMC_LO_PAGE_IMAGE_INDEX_INVALID, // 37
        //  KMC_LO_PAGE_IMAGE_INDEX_INVALID: The Image index specified for the current page is invalid.
        //  Make sure the Image index is >= 0 and < the total number of images in this page.
    
    KMC_LO_SUBMIT_DOCUMENT_MIMETYPE_ERROR, // 38
        //  KMC_LO_SUBMIT_DOCUMENT_MIMETYPE_ERROR: The MIME type specified for one or more of the Images in the Document is not supported for submission to the Server.
        //  Use a MIME type supported by the Server for each image in the Document to be submitted.
    KMC_LO_SUBMIT_DOCUMENT_IMAGE_REP_ERROR, // 39
        //  KMC_LO_SUBMIT_DOCUMENT_IMAGE_REP_ERROR: The Image Representation specified for one or more of the Images in the Document is not supported for submission to the Server.
        //  Use an Image Representation supported by the Server for each image in the Document to be submitted.
    
    KMC_LO_SUBMIT_DOCUMENT_IMAGE_FILE_MISSING, //40
        //  KMC_LO_SUBMIT_DOCUMENT_IMAGE_FILE_MISSING: The Image file indicated by the Image object in the Page cannot be found or has been deleted.
        //  When submitting a Document the Image objects in the Pages must reference existing Image files in the storage system.
    
    KMC_LO_OPERATION_CANCEL_ERROR, // 41
        // An error occurred while attempting to cancel the running operation.  The operation has been terminated.
        // Check your network connection and ask your Administrator to confirm that the operation was successfully cancelled.  Some manual clean-up may be necessary if normal cancellation procedures did not complete.
    
    KMC_LO_INVALID_SESSION_STATE_TRANSITION, //42
        // KMC_LO_INVALID_SESSION_STATE_TRANSITION: Attempt to transition from one Session State to a subsequent Session State, where the target State is not reachable from the current State.
        // Internal unexpected error.  No recommendation.
    KMC_LO_REGISTERING_NOT_ALLOWED, // 43
        // KMC_LO_REGISTERING_NOT_ALLOWED: Registering is not allowed from this session state.
        // You should log out and then re-register.
    
    KMC_LO_DOWNLOAD_DOCUMENT_SCAN_SETTINGS_ERROR, // 44
        // An error occurred attempting to download scan settings.
        // Check your network availability, server URL or WiFi connection.
    KMC_LO_EVENT_LOCK_ACQUIRE_ERROR, // 45
        // Attempt to acquire a lock for the event associated with this method failed.
        // (Android specific)
    
    KMC_LO_SERVER_CONNECTION, // 46
        // Network error: Could not connect to the server
        // Check your web services, the actual URL that you are using and verify the server port number.
    KMC_LO_SECURE_CONNECTION_UNAVAILABLE, // 47
        // Network error: A secure connection is not possible with this URL.
        // If you want to use SSL, using the prefix https://, then the server to which the URL is directed must allow a secure connection.  Verify your URL and port number as well as the services path appended to the end of your URL.
    KMC_LO_REQUEST_TIMEOUT, // 48
        // Network error: The request timed out.
        // Even though web services are available, there was no response to your web service request.  Contact your server administrator to ensure that it is active and available.
    KMC_LO_NETWORK_NOT_REACHABLE, //49
        // Network error: The network services are not available.
        // Check your device for WiFi services enabled or turn off “Airplane mode”.
    
    KMC_LO_NETWORK_AUTHENTICATION, //50
        // Could not authenticate this request.
        // Check your URL used with the request, and the request type.  This may an internal library failure, which is detected by the low-level web services logic.
    KMC_LO_NETWORK_HOST_UNAVAILABLE, // 51
        // Network error: The specified host is not available
        // Check your web services, the actual URL you are using, and ensure the server address is correct.  If it is correct, contact your server administrator to ensure that it is active and available.
    KMC_LO_WEB_SERVICE_FAILED, // 52
        // Network error: The server request resulted in an unknown web services error.
        // This default error occurs when the library could not determine the cause for the web services error.  This normally indicates a unique communication error.  After verifying your URL, Wifi connection, retry your server operation.
    KMC_LO_REGISTER_REQUIRES_AUTH,
    KMC_LO_INVALID_CERTIFICATE,// 54
        // Network error: The certificate is invalid .
       //  The certificate for this server is invalid. You might be connecting to a server which could put your confidential information at risk.
    KMC_LO_LAST
    
} KFX_ERROR_LOGISTICS_ERRORS;


typedef enum kfxErrorImageProcessor {
    IP_BASE = KMC_IP_BASE,
    KMC_IP_NO_PROFILE,
    KMC_IP_NO_REPRESENTATION,
    KMC_IP_CONTEXT,
    KMC_IP_LICENSE_INVALID,
    KMC_IP_LICENSE_EXPIRED,
    KMC_IP_LICENSE_ALREADY_SET,
    KMC_IP_BAD_FILENAME,
    KMC_IP_IMAGE_BUFFERED,
    KMC_IP_JAILBREAK_DETECTED,
    KMC_IP_NO_CONFIGURATION,
    
    
    
    KMC_IP_LAST
    
}KFX_ERROR_IMAGE_PROCESSOR;


typedef enum kfxErrorEv {
    
    KMC_EV_UNKNOWN = KMC_EV_BASE,

    KMC_EV_MEMORY,
    KMC_EV_FILEOPEN,
    KMC_EV_BAD_DPI,
    KMC_EV_BAD_WIDTH_HEIGHT,
    KMC_EV_BAD_LINEWIDTH,
    KMC_EV_BAD_CHANNEL,
    KMC_EV_METADATA_OVERFLOW,
    KMC_EV_FILE_READ_FAILED,
    KMC_EV_IMAGE_PARM,
    KMC_EV_IMAGE_PROCESSING,   // 0x0a
    KMC_EV_IMAGE_WRITE_FAILED, // 0x0b
    KMC_EV_UNKNOWN_FILETYPE,
    KMC_EV_NONEXISTANT_IMAGE,
    KMC_EV_BAD_FILE_FORMAT,
    KMC_EV_APPEND_TO_FILE,
    KMC_EV_CANNOT_APPEND, //0x10
    KMC_EV_PDF_BAD, // 0x11
    KMC_EV_APPEND_ENCRYPTED,
    KMC_EV_PDF_TOO_LARGE,
    KMC_EV_SPEED_ACCURACY,
    KMC_EV_FILE_METADATA,
    KMC_EV_INVALID_HANDLE,
    KMC_EV_EXTERNAL_PAGE,
    KMC_EV_HISTOGRAM,
    KMC_EV_INVALID_POINTER,
    KMC_EV_BARCODE_DRIVER,
    KMC_EV_LICENSING,
    KMC_EV_LICENSE_EXPIRED,
    KMC_EV_LOCK_CREATION_ERROR, // 0x20
    KMC_EV_FILE_IO_ACCESS_BUSY, // 0x21
    KMC_EV_PROCESS_PAGE_BUSY,
    KMC_EV_USER_ABORT,
    KMC_EV_META_DATA,   // EVRS_METADATA_FORMAT_ERROR             -1006
    KMC_EV_OP_STRING,   // EVRS_OPERATIONS_STRING_ERROR           -1007
    KMC_EV_INI_FORMAT,  // EVRS_INI_FORMAT_ERROR                  -1010
    KMC_EV_XML_FORMAT,  //  EVRS_XML_FORMAT_ERROR                  -1011
    KMC_EV_JSON_FORMAT, // EVRS_JSON_FORMAT_ERROR                 -1012
    
    KMC_EV_LAST
}KFX_ERROR_PERFECTION; 

typedef enum kfxClassifier {
    
    KMC_CL_UNKNOWN = KMC_CL_BASE,
    KMC_CL_CONFIG_NULL,
    KMC_CL_CONFIG_NOT_LOADED,
    KMC_CL_MODEL_NULL,
    KMC_CL_MODEL_NOT_LOADED,
    KMC_CL_LISTENER_NULL, // 5
    KMC_CL_MAX_NUM_RESULTS_INVALID,
    KMC_CL_CLASSIFIER_BUSY,
    KMC_CL_CLASSIFIER_NOT_INITIALIZED,
    KMC_CL_INVALID_IMAGE_SUPPLIED, // 9
    KMC_CL_NO_IMAGE_SUPPLIED, // 10
    KMC_CL_CLASSIFICATION_CONFIDENCE_LOW,
    KMC_CL_ID_CLASS_NOT_SUPPORTED,

    KMC_CL_LAST

}KFX_ERROR_CLASSIFIER;


typedef enum kfxErrorUtilities {
    KUT_BASE = KMC_UT_BASE,
    KMC_UT_STATS_RECORDING_NOT_OFF,
    KMC_UT_STATS_FILEPATH_IS_NULL,
    KMC_UT_STATS_EXPORT_HANDLER_MISSING,
    KMC_UT_STATS_NOTHING_TO_PURGE,
    KMC_UT_STATS_INIT_NOT_ALLOWED,
    KMC_UT_STATS_PURGE_NOT_ALLOWED,
    KMC_UT_STATS_EXPORT_NOT_ALLOWED,
    KMC_UT_STATS_RECORD_NOT_ALLOWED,
    KMC_UT_STATS_WRITING_NOT_ALLOWED,
    KMC_UT_STATS_ALREADY_RECORDING,
    KMC_UT_STATS_ALREADY_EXPORTING,
    KMC_UT_STATS_ALREADY_WRITING,
    KMC_UT_STATS_UNINITIALIZED,
    KMC_UT_STATS_STATE_BUSY,
    KMC_UT_STATS_INVALID_STATE_TRANSITION,
    KMC_UT_CREATE_DB_FAILED,
    KMC_UT_OPEN_DB_FAILED,
    KMC_UT_DB_INVALID_SCHEMA,
    KMC_UT_WRITEFILE_FAILED,
    KMC_UT_INVALID_EVENT,
    KMC_UT_NO_OBJECT,
    KMC_UT_STATS_RECORD_AND_WRITING_NOT_ALLOWED,
    KMC_UT_STATS_EVENT_THROTTLED,
    KMC_UT_STATS_NOTHING_TO_EXPORT,
    KMC_UT_STATS_INVALID_JSON,
    KMC_UT_STATS_RECORDING_NOT_ON,
    KMC_UT_STATS_DATASTORE_OUT_OF_DATE,
    KMC_UT_STATS_DATASTORE_UPGRADE_FAILED,
    KMC_UT_STATS_DATASTORE_NO_UPGRADE_PATH,
    KMC_UT_STATS_DATASTORE_UPGRADE_NOT_NEEDED,
    KMC_UT_STATS_DATASTORE_UPGRADE_WRONG_STATE,
    KMC_UT_STATS_DATASTORE_UPGRADE_MISSING_FILE,
    KMC_UT_STATS_LOG_SESSION_EVENT_NOT_ALLOWED,
    KMC_UT_STATS_DEVICE_ID_MISSING,
    KMC_UT_STATS_RECORDING_ALREADY_STOPPED,
    KMC_UT_STATS_NO_SESSION_BEGUN,
    KMC_UT_STATS_BEGIN_SESSION_NOT_ALLOWED,
    KMC_UT_STATS_SESSION_ALREADY_BEGUN,
    KMC_UT_STATS_END_SESSION_NOT_ALLOWED,
    KMC_UT_LICENSE_IMAGE_PROCESSING,
    KMC_UT_LICENSE_IMAGE_CAPTURE,
    KMC_UT_LICENSE_BARCODE_CAPTURE,
    KMC_UT_LICENSE_ON_DEVICE_EXTRACTION,
    KMC_UT_LICENSE_UNKNOWN_LICENSE_SERVER_TYPE,
    KMC_UT_OUT_OF_VOLUME_LICENSE,
    KMC_UT_LICENSING_NETWORK_EXCEPTION,
    KMC_UT_LAST
    
    
} KFX_ERROR_UTILITIES;

/*
  This enum defines the error codes for the kfxKBRBarcodeReader engine.
 */
typedef enum kfxErrorBarcodeReader{
    KMC_BC_NONE = KMC_BC_BASE+1,
    KMC_BC_UNKNOWN,
    KMC_BC_BAD_FILENAME,        // Invalid filename
    KMC_BC_IMAGE_BUFFERED,      // Buffered image is not supported
    KMC_BC_NO_DIRECTIONS,       // Search direction not specified
    KMC_BC_NO_SYMBOLOGIES,      // Symbology was not specified
    KMC_BC_NO_REPRESENTATION,   // Input file has no representation
    KMC_BC_INVALID_IMAGE,       // Invalid image data
    KMC_BC_BUSY,                // Read op already in progress
    KMC_BC_NO_BARCODE_FOUND,    // No barcode found on image
    KMC_BC_LAST
}KFX_ERROR_BARCODE_READER;


typedef enum kfxErrorExtraction {
    KMC_EX_UNKNOWN = KMC_EX_BASE,
    KMC_EX_PARSE_RESPONSE,
    KMC_EX_FORM_REQUEST,
    KMC_EX_CREDENTIALS,
    KMC_EX_INTERNAL_SERVER,
    KMC_EX_ONDEVICE_EXTRACTION_NOT_SUPPORTED,
    KMC_EX_UNSUPPORTED_REGION,
    KMC_EX_CLASSIFICATION_CONFIG_NOT_FOUND,
    KMC_EX_PROCESSING_CONFIG_NOT_FOUND,
    KMC_EX_EXTRACTION_CONFIG_NOT_FOUND,
    KMC_EX_CLASSIFICATION_FAILED,
    KMC_EX_PROCESSING_FAILED,
    KMC_EX_EXTRACTION_FAILED,
    KMC_EX_OCR_FAILED,
    KMC_EX_BUSY,
    KMC_EX_NOIMAGE,
    KMC_EX_NOREGION,
    KMC_EX_CANCEL_OPERATION_SUCCESS,
    KMC_EX_INVALID_BARCODE_STRING,
    KMC_EX_ASSET_INTEGRITY_FAILURE,
    KMC_EX_BUNDLE_NOT_FOUND,
    KMC_EX_PROJECT_ALREADY_LOADING,
    KMC_EX_OPEN_ARCHIVE_FAILED,
    KMC_EX_SESSIONID_NOT_FOUND,
    KMC_EX_ENCRYPTED_BARCODE_STRING,
    KMC_EX_LAST
} KFX_ERROR_EXTRACTION;


@interface kfxError : NSObject

// ==========================================================

+ (NSString *) findErrMsg: (int) inputErrorCode;


// ==========================================================

+ (NSString *) findErrDesc: (int) inputErrorCode;

@end
#endif