ca.uhn.hl7v2.ErrorCode Maven / Gradle / Ivy

/**
The contents of this file are subject to the Mozilla Public License Version 1.1 
(the "License"); you may not use this file except in compliance with the License. 
You may obtain a copy of the License at http://www.mozilla.org/MPL/ 
Software distributed under the License is distributed on an "AS IS" basis, 
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the 
specific language governing rights and limitations under the License. 

The Original Code is "ErrorCode.java".  Description: 
"Error code enumeration." 

The Initial Developer of the Original Code is University Health Network. Copyright (C) 
2012.  All Rights Reserved. 

Contributor(s): ______________________________________. 

Alternatively, the contents of this file may be used under the terms of the 
GNU General Public License (the "GPL"), in which case the provisions of the GPL are 
applicable instead of those above.  If you wish to allow use of your version of this 
file only under the terms of the GPL and not to allow others to use your version 
of this file under the MPL, indicate your decision by deleting  the provisions above 
and replace  them with the notice and other provisions required by the GPL License.  
If you do not delete the provisions above, a recipient may use your version of 
this file under either the MPL or the GPL. 
 */
package ca.uhn.hl7v2;

/**
 * Error code table
 *
 */
public enum ErrorCode {
	MESSAGE_ACCEPTED(0, "Message accepted"), 
	SEGMENT_SEQUENCE_ERROR(100, "Segment sequence error"), 
	REQUIRED_FIELD_MISSING(101, "Required field missing"), 
	DATA_TYPE_ERROR(102, "Data type error"), 
	TABLE_VALUE_NOT_FOUND(103, "Table value not found"),
	UNSUPPORTED_MESSAGE_TYPE(200, "Unsupported message type"),
	UNSUPPORTED_EVENT_CODE(201, "Unsupported event code"),
	UNSUPPORTED_PROCESSING_ID(202, "Unsupported processing id"),
	UNSUPPORTED_VERSION_ID(203, "Unsupported version id"),
	UNKNOWN_KEY_IDENTIFIER(204, "Unknown key identifier"),
	DUPLICATE_KEY_IDENTIFIER(205, "Duplicate key identifier"),
	APPLICATION_RECORD_LOCKED(206, "Application record locked"),
	APPLICATION_INTERNAL_ERROR(207, "Application internal error");

	private static final String HL70357 = "HL70357";
    private final int code;
	private final String message;

	ErrorCode(int errCode, String message) {
		this.code = errCode;
		this.message = message;
	}

    /**
     * @return the integer error code
     */
	public int getCode() {
		return code;
	}

    /**
     * @return the error code message
     */
	public String getMessage() {
		return message;
	}

    /**
     * Returns the ErrorCode for the given integer
     * @param errCode integer error code
     * @return ErrorCode
     */
	public static ErrorCode errorCodeFor(int errCode) {
		for (ErrorCode err : ErrorCode.values()) {
			if (err.code == errCode) {
				return err;
			}
		}
		return null;
	}

    /**
     * @return the HL7 table number
     */
	public static String codeTable() {
		return HL70357;
	}
}