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.model;
18
19 /**
20 * Interface for elements of the SCXML object model whose progress
21 * can be observed using the {@link org.apache.commons.scxml2.NotificationRegistry}. These include
22 * individual {@link TransitionTarget}s, {@link Transition}s or the entire state
23 * machine {@link SCXML}.
24 *
25 * <p>Note: it is assumed there will be no more than Integer.MAX_VALUE of such elements in a single SCXML document</p>
26 */
27 public interface Observable {
28
29 /**
30 * @return Returns the id for this Observable which is unique within the SCXML state machine
31 */
32 Integer getObservableId();
33 }
34