KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > ccm > IDL3 > OperationDecl


1 /*====================================================================
2
3 OpenCCM: The Open CORBA Component Model Platform
4 Copyright (C) 2000-2002 USTL - LIFL - GOAL
5 Contact: openccm-team@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Philippe Merle, Mathieu Vadet.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/
26
27 package org.objectweb.ccm.IDL3;
28
29 /**
30  * This interface manages IDL operation declarations.
31  *
32  * @author <a=href="Philippe.Merle@lifl.fr">Philippe Merle</a>
33  * <a=href="Mathieu.Vadet@lifl.fr">Mathieu Vadet</a>
34  *
35  * @version 0.3
36  */
37
38 public interface OperationDecl
39        extends Declaration, WithInParameters
40 {
41     /** TODO: COMMENT */
42     public static int OP_NORMAL = org.omg.CORBA.OperationMode._OP_NORMAL;
43
44     /** TODO: COMMENT */
45     public static int OP_ONEWAY = org.omg.CORBA.OperationMode._OP_ONEWAY;
46
47     /** TODO: COMMENT */
48     public static int PARAM_IN = org.omg.CORBA.ParameterMode._PARAM_IN;
49
50     /** TODO: COMMENT */
51     public static int PARAM_OUT = org.omg.CORBA.ParameterMode._PARAM_OUT;
52
53     /** TODO: COMMENT */
54     public static int PARAM_INOUT = org.omg.CORBA.ParameterMode._PARAM_INOUT;
55
56     /**
57      * Set mode as normal.
58      */
59     public void
60     setNormal();
61
62     /**
63      * Set mode as oneway.
64      */
65     public void
66     setOneway();
67
68     /**
69      * Set the result type.
70      *
71      * @param type The TypeRef of the returned object.
72      */
73     public void
74     setResultType(TypeRef type);
75
76     /**
77      * Add an out parameter.
78      *
79      * @param name The name of the parameter.
80      * @param type The TypeRef of the parameter.
81      */
82     public void
83     addOutParam(String JavaDoc name, TypeRef type);
84
85     /**
86      * Add an inout parameter.
87      *
88      * @param name The name of the parameter.
89      * @param type The TypeRef of the parameter.
90      */
91     public void
92     addInOutParam(String JavaDoc name, TypeRef type);
93
94     /**
95      * Add a context.
96      *
97      * @param name The name of the context.
98      */
99     public void
100     addContext(String JavaDoc name);
101
102     /**
103      * Is it oneway?
104      *
105      * @return True if oneway operation, else false.
106      */
107     public boolean
108     isOneway();
109
110     /**
111      * Obtain the result type.
112      *
113      * @return The result type.
114      */
115     public TypeRef
116     getType();
117
118     /**
119      * Obtain the exception list.
120      *
121      * @return The exception list.
122      */
123     public ExceptionList
124     getExceptionList();
125
126     /**
127      ** Obtain the exceptions list.
128      **
129      ** @return The list of exceptions that can be raised.
130      **/
131     public ExceptionDecl[]
132     getExceptions();
133
134     /**
135      * Obtain the parameter list.
136      *
137      * @return The parameter list.
138      */
139     public ParameterList
140     getParameters();
141
142     /**
143      * Obtain the contexts.
144      *
145      * @return The contexts.
146      */
147     public String JavaDoc[]
148     getContexts();
149 }
150
Popular Tags