1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17 package org.apache.commons.scxml2;
18
19 /**
20 * An interface for reporting SCXML errors to the host environment,
21 * containing the definition of commonly occuring errors while executing
22 * SCXML documents.
23 *
24 */
25 public interface ErrorReporter {
26
27 /**
28 * Handler for reporting an error.
29 *
30 * @param errCode
31 * one of the ErrorReporter's constants
32 * @param errDetail
33 * human readable description
34 * @param errCtx
35 * typically an SCXML element which caused an error,
36 * may be accompanied by additional information
37 */
38 void onError(String errCode, String errDetail, Object errCtx);
39 }