KickJava   Java API By Example, From Geeks To Geeks.

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


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 value type 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 ValueDecl
39        extends ForwardScope
40 {
41     /**
42      * Set as custom.
43      */
44     public void
45     setCustom();
46
47     /**
48      * Set as abstract.
49      */
50     public void
51     setAbstract();
52
53     /**
54      * Set as truncatable.
55      */
56     public void
57     setTruncatable();
58
59     /**
60      * Set the base value.
61      *
62      * @param value The base value.
63      */
64     public void
65     setBaseValue(ValueRef value);
66
67     /**
68      * Add an abstract base value.
69      *
70      * @param value The abstract base value.
71      */
72     public void
73     addAbstractValue(ValueRef value);
74
75     /**
76      * Add a supported interface.
77      *
78      * @param itf The supported interface.
79      */
80     public void
81     addInterface(InterfaceRef itf);
82
83     /**
84      * Is it custom?
85      *
86      * @return True if custom, else false.
87      */
88     public boolean
89     isCustom();
90
91     /**
92      * Is it abstract?
93      *
94      * @return True if abstract, else false.
95      */
96     public boolean
97     isAbstract();
98
99     /**
100      * Is it truncatable?
101      *
102      * @return True if truncatable, else false.
103      */
104     public boolean
105     isTruncatable();
106
107     /**
108      * Is it primary key?
109      *
110      * @return True if primary key, else false.
111      */
112     public boolean
113     isPrimaryKey();
114
115     /**
116      * Obtain the base value.
117      *
118      * @return The base value.
119      */
120     public ValueDecl
121     getBaseValue();
122
123     /**
124      * Obtain the abstract values.
125      *
126      * @return The abstract values.
127      */
128     public ValueDecl[]
129     getAbstractValues();
130
131     /**
132      * Obtain the supported interfaces.
133      *
134      * @return The supported interfaces.
135      */
136     public InterfaceDecl[]
137     getSupportedInterfaces();
138
139     /**
140      * Obtain the initializers.
141      *
142      * @return The initializers.
143      */
144     public Initializer[]
145     getInitializers();
146 }
147
Popular Tags