View Javadoc

1   /*
2    *
3    *   Copyright 2005 The Apache Software Foundation.
4    *
5    *  Licensed under the Apache License, Version 2.0 (the "License");
6    *  you may not use this file except in compliance with the License.
7    *  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   */
18  package org.apache.commons.scxml.model;
19  
20  import java.util.Collection;
21  
22  import org.apache.commons.logging.Log;
23  import org.apache.commons.scxml.ErrorReporter;
24  import org.apache.commons.scxml.EventDispatcher;
25  import org.apache.commons.scxml.SCInstance;
26  import org.apache.commons.scxml.SCXMLExpressionException;
27  
28  /***
29   * The class in this SCXML object model that corresponds to the
30   * <cancel> SCXML element.
31   *
32   */
33  public final class Cancel extends Action {
34  
35      /***
36       * Constructor.
37       */
38      public Cancel() {
39          super();
40      }
41  
42      /***
43       * The ID of the send message that should be cancelled.
44       */
45      private String sendid;
46  
47      /***
48       * Get the ID of the send message that should be cancelled.
49       *
50       * @return Returns the sendid.
51       */
52      public String getSendid() {
53          return sendid;
54      }
55  
56      /***
57       * Set the ID of the send message that should be cancelled.
58       *
59       * @param sendid The sendid to set.
60       */
61      public void setSendid(final String sendid) {
62          this.sendid = sendid;
63      }
64  
65      /***
66       * {@inheritDoc}
67       */
68      public void execute(final EventDispatcher evtDispatcher,
69              final ErrorReporter errRep, final SCInstance scInstance,
70              final Log appLog, final Collection derivedEvents)
71      throws ModelException, SCXMLExpressionException {
72          evtDispatcher.cancel(sendid);
73      }
74  
75  }
76