Package org.openehealth.ipf.commons.ihe.xds.core.responses

Enum ErrorCode

    • Enum Constant Detail

      • MISSING_DOCUMENT

        public static final ErrorCode MISSING_DOCUMENT
        Document entry exists in metadata with no corresponding attached document.

      • MISSING_DOCUMENT_METADATA

        public static final ErrorCode MISSING_DOCUMENT_METADATA
        MIME package contains MIME part with content-id header not found in metadata.

      • REGISTRY_NOT_AVAILABLE

        public static final ErrorCode REGISTRY_NOT_AVAILABLE
        Repository was unable to access the registry.

      • REGISTRY_ERROR

        public static final ErrorCode REGISTRY_ERROR
        Internal error in registry.

      • REPOSITORY_ERROR

        public static final ErrorCode REPOSITORY_ERROR
        Internal error in repository.

      • REGISTRY_DUPLICATE_UNIQUE_ID_IN_MESSAGE

        public static final ErrorCode REGISTRY_DUPLICATE_UNIQUE_ID_IN_MESSAGE
        The registry found a unique ID value that was used more than once within the submission. The Code Context indicates the duplicate unique ID.

      • REPOSITORY_DUPLICATE_UNIQUE_ID_IN_MESSAGE

        public static final ErrorCode REPOSITORY_DUPLICATE_UNIQUE_ID_IN_MESSAGE
        The repository found a unique ID value that was used more than once within the submission. The Code Context indicates the duplicate unique ID.

      • DUPLICATE_UNIQUE_ID_IN_REGISTRY

        public static final ErrorCode DUPLICATE_UNIQUE_ID_IN_REGISTRY
        A unique ID received for a submission set or folder was not unique within the registry. The code context indicates the value of the non-unique ID and if it was a folder or submission set. Never returned for a document entry.

      • NON_IDENTICAL_HASH

        public static final ErrorCode NON_IDENTICAL_HASH
        Document being registered was a duplicate (unique ID already in registry) but the hash codes do not match. The code context indicates the unique ID.

      • NON_IDENTICAL_SIZE

        public static final ErrorCode NON_IDENTICAL_SIZE
        Document being registered was a duplicate (uniqueId already in registry) but size does not match. CodeContext indicates UniqueId.

      • REGISTRY_BUSY

        public static final ErrorCode REGISTRY_BUSY
        Too much activity in the registry to process the request.

      • REPOSITORY_BUSY

        public static final ErrorCode REPOSITORY_BUSY
        Too much activity in the repository to process the request.

      • REGISTRY_OUT_OF_RESOURCES

        public static final ErrorCode REGISTRY_OUT_OF_RESOURCES
        Resources are too low within the registry to process the request.

      • REPOSITORY_OUT_OF_RESOURCES

        public static final ErrorCode REPOSITORY_OUT_OF_RESOURCES
        Resources are too low within the repository to process the request.

      • REGISTRY_METADATA_ERROR

        public static final ErrorCode REGISTRY_METADATA_ERROR
        The registry detected an error in the meta data. The actor name indicates where error detected. The code context indicates the nature of the problem.

      • REPOSITORY_METADATA_ERROR

        public static final ErrorCode REPOSITORY_METADATA_ERROR
        The repository detected an error in the meta data. The actor name indicates where error detected. The code context indicates the nature of the problem.

      • TOO_MANY_RESULTS

        public static final ErrorCode TOO_MANY_RESULTS
        A request produced too many results to finish the request.

      • EXTRA_METADATA_NOT_SAVED

        public static final ErrorCode EXTRA_METADATA_NOT_SAVED
        Warning returned if extra meta data was present but not saved in the registry.

      • UNKNOWN_PATIENT_ID

        public static final ErrorCode UNKNOWN_PATIENT_ID
        The patient ID referenced in the meta data is not known to the registry actor via the Patient Identity Feed or is unknown because of patient identifier merge or other reasons. The code context includes the value of the problematic patient ID.

      • PATIENT_ID_DOES_NOT_MATCH

        public static final ErrorCode PATIENT_ID_DOES_NOT_MATCH
        A patient ID that is required to be identical in the document entries, folders and submission sets contained in the request did not match. The code context indicates the value of the patient ID and the nature of the conflict.

      • UNKNOWN_STORED_QUERY

        public static final ErrorCode UNKNOWN_STORED_QUERY
        The query ID provided in the request is not recognized.

      • STORED_QUERY_MISSING_PARAM

        public static final ErrorCode STORED_QUERY_MISSING_PARAM
        A required parameter to a stored query is missing.

      • STORED_QUERY_PARAM_NUMBER

        public static final ErrorCode STORED_QUERY_PARAM_NUMBER
        A parameter which only accepts a single value is coded with multiple values.

      • REGISTRY_DEPRECATED_DOCUMENT_ERROR

        public static final ErrorCode REGISTRY_DEPRECATED_DOCUMENT_ERROR
        A register transaction was rejected because it submitted an association referencing a deprecated document.

      • UNKNOWN_REPOSITORY_ID

        public static final ErrorCode UNKNOWN_REPOSITORY_ID
        The unique ID of a repository could not be resolved to a valid document repository or the value does not match that of the document repository.

      • DOCUMENT_UNIQUE_ID_ERROR

        public static final ErrorCode DOCUMENT_UNIQUE_ID_ERROR
        The document associated with the DocumentUniqueId is not available.

      • RESULT_NOT_SINGLE_PATIENT

        public static final ErrorCode RESULT_NOT_SINGLE_PATIENT
        A query resulted in returning information about multiple patients, which is forbidden because of security reasons.

      • PARTIAL_FOLDER_CONTENT_NOT_PROCESSED

        public static final ErrorCode PARTIAL_FOLDER_CONTENT_NOT_PROCESSED
        An XDR Document Recipient did not process some part of the content. Specifically the parts not processed are Folder semantics.

      • PARTIAL_REPLACE_CONTENT_NOT_PROCESSED

        public static final ErrorCode PARTIAL_REPLACE_CONTENT_NOT_PROCESSED
        An XDR Document Recipient did not process some part of the content. Specifically the parts not processed are Replacement semantics.

      • PARTIAL_TRANSFORM_NOT_PROCESSED

        public static final ErrorCode PARTIAL_TRANSFORM_NOT_PROCESSED
        An XDR Document Recipient did not process some part of the content. Specifically the parts not processed are Transform semantics.

      • PARTIAL_APPEND_CONTENT_NOT_PROCESSED

        public static final ErrorCode PARTIAL_APPEND_CONTENT_NOT_PROCESSED
        An XDR Document Recipient did not process some part of the content. Specifically the parts not processed are Append semantics.

      • PARTIAL_RELATIONSHIP_CONTENT_NOT_PROCESSED

        public static final ErrorCode PARTIAL_RELATIONSHIP_CONTENT_NOT_PROCESSED
        An XDR Document Recipient did not process some part of the content. Specifically the parts not processed are Relationship Association semantics.

      • PARTIAL_TRANSFORM_REPLACE_NOT_PROCESSED

        public static final ErrorCode PARTIAL_TRANSFORM_REPLACE_NOT_PROCESSED
        An XDR Document Recipient did not process some part of the content. Specifically the parts not processed are Transform and Replace semantics.

      • DOCUMENT_QUEUED

        public static final ErrorCode DOCUMENT_QUEUED
        An XDR Recipient queued the document for future manual matching to a patient.

      • INVALID_DOCUMENT_CONTENT

        public static final ErrorCode INVALID_DOCUMENT_CONTENT
        The recipient has rejected this submission because it detected that one of the documents does not match the metadata or has failed other requirements for the document content.

      • UNKNOWN_COMMUNITY

        public static final ErrorCode UNKNOWN_COMMUNITY
        A value for the homeCommunityId is not recognized

      • MISSING_HOME_COMMUNITY_ID

        public static final ErrorCode MISSING_HOME_COMMUNITY_ID
        A value for the homeCommunityId is required and has not been specified

      • UNAVAILABLE_COMMUNITY

        public static final ErrorCode UNAVAILABLE_COMMUNITY
        A community which would have been contacted was not available

      • TRANSCODING_ERROR

        public static final ErrorCode TRANSCODING_ERROR
        The requested document cannot be provided due to a transcoding/translation error.

      • METADATA_UPDATE_ERROR

        public static final ErrorCode METADATA_UPDATE_ERROR
        General metadata update error. Use only when more specific error code is not available or appropriate.

      • PATIENT_ID_RECONCILIATION_ERROR

        public static final ErrorCode PATIENT_ID_RECONCILIATION_ERROR
        Update encountered error where Patient IDs did not match.

      • METADATA_UPDATE_OPERATION_ERROR

        public static final ErrorCode METADATA_UPDATE_OPERATION_ERROR
        Document Registry/Recipient cannot decode the requested metadata update.

      • METADATA_VERSION_ERROR

        public static final ErrorCode METADATA_VERSION_ERROR
        The version number included in the update request did not match the existing object. One cause of this is multiple simultaneous update attempts.

      • REMOVE_DOCUMENTS_ERROR

        public static final ErrorCode REMOVE_DOCUMENTS_ERROR
        The Document Repository was not able to remove the document. The codeContext shall indicate the DocumentUniqueId of the document that caused the error.

      • UNRESOLVED_REFERENCE_EXCEPTION

        public static final ErrorCode UNRESOLVED_REFERENCE_EXCEPTION
        The recipient cannot resolve an entryUUID reference in the transaction.

      • REFERENCE_EXISTS_EXCEPTION

        public static final ErrorCode REFERENCE_EXISTS_EXCEPTION
        An entryUUID passed in the Delete Document Set transaction is referenced by an Association sourceObject or targetObject attribute.

      • UNREFERENCED_OBJECT_EXCEPTION

        public static final ErrorCode UNREFERENCED_OBJECT_EXCEPTION
        A metadata object is no longer referenced by any Association.

      • REPLACE_FAILED

        @Deprecated
public static final ErrorCode REPLACE_FAILED
        Deprecated.
        this error code is deprecated by IHE
        Error detected by the Document Registry during a document replacement.

      • OBJECT_TYPE_ERROR

        public static final ErrorCode OBJECT_TYPE_ERROR
        The receiving actor cannot store the request as the objectType is either not supported or does not match the value of the existing object.

      • METADATA_IDENTIFIER_ERROR

        public static final ErrorCode METADATA_IDENTIFIER_ERROR
        The receiving actor cannot store the request because the identifier is in conflict with an existing known value.

      • INVALID_REQUEST_EXCEPTION

        public static final ErrorCode INVALID_REQUEST_EXCEPTION
        The receiving actor detected that an initial version of a metadata object instance was received in an update transaction.

      • UNMODIFIABLE_METADATA_ERROR

        public static final ErrorCode UNMODIFIABLE_METADATA_ERROR
        An update for a metadata object includes changes to values for attributes which are prohibited for the transaction.

      • LOCAL_POLICY_RESTRICTION_ERROR

        public static final ErrorCode LOCAL_POLICY_RESTRICTION_ERROR
        The receiving actor has detected that the request is not permitted because of local policy restrictions or violation of a previously reached agreement.

      • METADATA_ANNOTATION_ERROR

        public static final ErrorCode METADATA_ANNOTATION_ERROR
        The receiving actor has detected an error with a SS-HM annotation.

      • SQL_ERROR

        public static final ErrorCode SQL_ERROR
        An error occurred when executing an SQL query.

      • _USER_DEFINED

        public static final ErrorCode _USER_DEFINED

    • Method Detail

      • values

        public static ErrorCode[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (ErrorCode c : ErrorCode.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static ErrorCode valueOf​(String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        IllegalArgumentException - if this enum type has no constant with the specified name
        NullPointerException - if the argument is null

      • getOpcode

        public String getOpcode()
        Returns:
        string representation for usage in ebXML values.

      • getOpcode

        public static String getOpcode​(ErrorCode errorCode)
        null-safe version of getOpcode().
        Parameters:
        errorCode - the error code. Can be null.
        Returns:
        the string representation or null if errorCode was null.

      • valueOfOpcode

        public static ErrorCode valueOfOpcode​(String opcode)
        Returns the error code that corresponds to the given opcode.
        Parameters:
        opcode - the opcode. Can be null.
        Returns:
        the error code. null when the opcode is null or empty, _USER_DEFINED when the code is not a standard one.