001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements.  See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache License, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License.  You may obtain a copy of the License at
008 *
009 *     http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the License for the specific language governing permissions and
015 * limitations under the License.
016 */
017package org.apache.commons.scxml2;
018
019/**
020 * An interface for reporting SCXML errors to the host environment,
021 * containing the definition of commonly occuring errors while executing
022 * SCXML documents.
023 *
024 */
025public interface ErrorReporter {
026
027    /**
028     * Handler for reporting an error.
029     *
030     * @param errCode
031     *            one of the ErrorReporter's constants
032     * @param errDetail
033     *            human readable description
034     * @param errCtx
035     *            typically an SCXML element which caused an error,
036     *            may be accompanied by additional information
037     */
038    void onError(String errCode, String errDetail, Object errCtx);
039}