# BarcodeResult ## BarcodeResult.Status ```{list-table} :align: left :class: list-table * - Constant - Description * - SUCCESS - Success * - DAILED - Failure ``` --- ## BarcodeResult.Result ```{list-table} :align: left :class: list-table * - Constant - Description * - UNKNOWN - Unknown result * - SYSTEM_BEEP_TYPE1 - Short high-pitched beep * - SYSTEM_BEEP_TYPE2 - Short low-pitched beep * - SYSTEM_BEEP_TYPE3 - Long high-pitched beep * - SYSTEM_BEEP_TYPE4 - Long low-pitched beep * - SYSTEM_BEEP_TYPE5 - Fast warp sound * - SYSTEM_BEEP_TYPE6 - Slow warp sound * - SYSTEM_BEEP_TYPE7 - High click sound * - SYSTEM_BEEP_TYPE8 - Low click sound * - SYSTEM_BEEP_SOUND_NONE - No beep * - FACTORY_DEFAULT - Reset to factory default * - CHARACTER_NONE - No character * - CHARACTER_SYMBOL - Symbol CodeID character * - CHARACTER_AIM - AIM CodeID character * - STOP_CONDITIONS_CONTINUOUS_ON - Continuous read On * - STOP_CONDITIONS_CONTINUOUS_OFF - Continuous read Off * - SYMBOLOGY_STATUS_GET - Get barcode status * - SYMBOLOGY_STATUS_SET - Set barcode status * - OCR_STATUS_GET - Get OCR status * - OCR_STATUS_SET - Set OCR status * - FORMAT_DATA_ONLY - Raw data * - FORMAT_DATA_SUFFIX_TYPE1 - Barcode + SUFFIX1 * - FORMAT_DATA_SUFFIX_TYPE2 - Barcode + SUFFIX2 * - FORMAT_DATA_SUFFIX_TYPE3 - Barcode + SUFFIX1 + SUFFIX2 * - FORMAT_PREFIX_DATA - PREFIX + Barcode * - FORMAT_PREFIX_DATA_SUFFIX_TYPE1 - PREFIX + Barcode + SUFFIX1 * - FORMAT_PREFIX_DATA_SUFFIX_TYPE2 - PREFIX + Barcode + SUFFIX2 * - FORMAT_PREFIX_DATA_SUFFIX_TYPE3 - PREFIX + Barcode + SUFFIX1 + SUFFIX2 * - NOTIS_EDITING_GET_ENABLED - NOTIS editing On * - NOTIS_EDITING_GET_DISABLED - NOTIS editing Off ``` --- ## BarcodeResult ### Constructor ```java public BarcodeResult() ``` ### Description Creates a `BarcodeResult` object. ### Sample ```java BarcodeResult result = new BarcodeResult(); ``` --- ### Constructor with Parameters ```java public BarcodeResult(Status status, Result result, String message, ArrayList array) ``` #### Parameters ```{list-table} :align: left :class: list-table * - Name - Type - Description * - status - Status - Result status * - result - Result - Result code * - message - String - Message text * - array - ArrayList - Array of [`SymbologyInfoModel`](SymbologyInfoModel.md) ``` ### Description Creates a `BarcodeResult` object with specified parameters. ### Sample ```java BarcodeResult barcodeResult = new BarcodeResult( BarcodeResult.Status.SUCCESS, BarcodeResult.Result.SYMBOLOGY_STATUS_SET, "", null ); ``` --- ## getResult ```java public Result getResult() ``` ### Returns ```{list-table} :align: left :class: list-table * - Type - Description * - Result - Result code ``` ### Description Retrieves the result code from a `BarcodeResult` object. ### Sample ```java Result result = barcodeResult.getResult(); ``` --- ## setResult ```java public void setResult(Result result) ``` ### Parameters ```{list-table} :align: left :class: list-table * - Name - Type - Description * - result - Result - Result code to set ``` ### Description Sets the result code in a `BarcodeResult` object. ### Sample ```java barcodeResult.setResult(Result.SYSTEM_BEEP_TYPE1); ``` --- ## getMessage ```java public String getMessage() ``` ### Returns ```{list-table} :align: left :class: list-table * - Type - Description * - String - Message text ``` ### Description Retrieves the message from a `BarcodeResult` object. ### Sample ```java String message = barcodeResult.getMessage(); ``` --- ## setMessage ```java public void setMessage(String msg) ``` ### Parameters ```{list-table} :align: left :class: list-table * - Name - Type - Description * - msg - String - Message text to set ``` ### Description Sets the message in a `BarcodeResult` object. ### Sample ```java barcodeResult.setMessage("message"); ``` --- ## getSymbologyInfoArray ```java public ArrayList getSymbologyInfoArray() ``` ### Returns ```{list-table} :align: left :class: list-table * - Type - Description * - ArrayList - Array of [`SymbologyInfoModel`](SymbologyInfoModel.md) ``` ### Description Retrieves the array of symbology information indicating which barcodes are readable. ### Sample ```java ArrayList array = barcodeResult.getSymbologyInfoArray(); ``` --- ## setSymbologyInfoArray ```java public void setSymbologyInfoArray(ArrayList array) ``` ### Parameters ```{list-table} :align: left :class: list-table * - Name - Type - Description * - array - ArrayList - Array of [`SymbologyInfoModel`](SymbologyInfoModel.md) ``` ### Description Sets which barcodes are readable in the `BarcodeResult` object. ### Sample ```java ArrayList infoModelArrayList = new ArrayList<>(); infoModelArrayList.add(new SymbologyInfoModel(Symbology.UPC_A, true)); infoModelArrayList.add(new SymbologyInfoModel(Symbology.UPC_E, true)); barcodeResult.setSymbologyInfoArray(infoModelArrayList); ``` --- ## getOCRInfoArray ```java public ArrayList getOCRInfoArray() ``` ### Returns ```{list-table} :align: left :class: list-table * - Type - Description * - ArrayList - Array of [`OCRInfoModel`](OCRInfoModel.md) ``` ### Description Retrieves OCR mode information (OCR-A, OCR-B) and their enabled status. ### Sample ```java ArrayList array = barcodeResult.getOCRInfoArray(); ``` --- ## setOCRInfoArray ```java public void setOCRInfoArray(ArrayList array) ``` ### Parameters ```{list-table} :align: left :class: list-table * - Name - Type - Description * - array - ArrayList - Array of [`OCRInfoModel`](OCRInfoModel.md) ``` ### Description Sets OCR mode information (OCR-A, OCR-B) and their enabled/disabled status. ### Sample ```java OCRInfoModel model = new OCRInfoModel(OCR.OCR_A, true); ArrayList infoModelArrayList = new ArrayList<>(); infoModelArrayList.add(model); barcodeResult.setOCRInfoArray(infoModelArrayList); ```