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.choreography;
20  
21  import org.wsmo.service.choreography.rule.ChoreographyRules;
22  import org.wsmo.service.signature.*;
23  
24  /**
25   * TODO Comment this type.
26   * 
27   * <pre>
28   *      Created on Jul 26, 2005
29   *      Committed by $Author: vassil_momtchev $
30   *      $Source$
31   * </pre>
32   * 
33   * @author James Scicluna
34   * @author Thomas Haselwanter
35   * @author Holger Lausen
36   * @author Vassil Momtchev
37   * 
38   * @version $Revision: 1844 $ $Date: 2006-10-24 17:11:48 +0300 (Tue, 24 Oct 2006) $
39   */
40  public interface Choreography extends org.wsmo.service.Choreography {
41  
42      /**
43       * Returns the <code>StateSignature</code> of this choreograhy or
44       * null if the StateSignature was not set.
45       * @return <code>StateSignature</code> or null
46       */
47      public StateSignature getStateSignature();
48  
49      /**
50       * Sets the <code>StateSignature</code> of this choreograhy.
51       * @param stateSignature <code>StateSignature</code> or null
52       */
53      public void setStateSignature(StateSignature stateSignature);
54      
55      /**
56       * Returns the <code>Rules</code> container of this choreography
57       * or null if the Rules container was not set.
58       * @return <code>Rules</code> object or null
59       */
60      public ChoreographyRules getRules();
61      
62      /**
63       * Sets the <code>Rules</code> container of this choreography or
64       * null to remove the current Rules container.
65       * @param rules <code>Rules</code> object or null
66       */
67      public void setRules(ChoreographyRules rules);
68  
69  }