View Javadoc

1   /*
2    wsmo4j extension - a Choreography API and Reference Implementation
3   
4    Copyright (c) 2005, University of Innsbruck, Austria
5   
6    This library is free software; you can redistribute it and/or modify it under
7    the terms of the GNU Lesser General Public License as published by the Free
8    Software Foundation; either version 2.1 of the License, or (at your option)
9    any later version.
10   This library is distributed in the hope that it will be useful, but WITHOUT
11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12   FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
13   details.
14   You should have received a copy of the GNU Lesser General Public License along
15   with this library; if not, write to the Free Software Foundation, Inc.,
16   59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17   */
18  
19  package org.wsmo.service.signature;
20  
21  import java.util.Set;
22  
23  /**
24   * Extends Mode and defines the method getGrounding to be implemented by the
25   * grounded modes
26   * 
27   * @author James Scicluna
28   * @author Thomas Haselwanter
29   * 
30   * Created on 26-Sep-2005 Committed by $Author: vassil_momtchev $
31   * 
32   * $Source:
33   * /cvsroot/wsmo4j/ext/choreography/src/api/org/wsmo/service/choreography/signature/GroundedMode.java,v $,
34   * @version $Revision: 1849 $ $Date: 2006-10-24 17:56:41 +0300 (Tue, 24 Oct 2006) $
35   */
36  
37  public interface GroundedMode extends Mode {
38  
39      /**
40       * Returns the grounding object entries of the Grounded mode
41       * 
42       * @return Set of Grounding objects and throws a NotGroundedException if no
43       *         grounding is defined.
44       * @throws NotGroundedException
45       */
46      public Set<Grounding> getGrounding() throws NotGroundedException;
47  
48      /**
49       * Adds a grounding specification to the Grounded Mode
50       * 
51       * @param g
52       *            A Grounding object to be added
53       */
54      public void addGrounding(Grounding g);
55  
56      /**
57       * Removes a grounding specification from the Grounded Mode
58       * 
59       * @param g
60       *            A Grounding object to be removed
61       */
62      public void removeGrounding(Grounding g);
63  
64  }