View Javadoc

1   /***
2    * JFoxSOAF, Service-Oriented Application Framework
3    * 
4    * Copyright (C) www.huihoo.org
5    * 
6    * Distributable under GNU LGPL For more information, please visit:
7    * http://www.huihoo.org/jfox/jfoxsoaf
8    */
9   
10  package org.huihoo.jfox.soaf.container;
11  
12  import java.util.Enumeration;
13  
14  import org.huihoo.jfox.soaf.schema.service.Parameter;
15  
16  /***
17   * <p>
18   * The service entry is used to access a boundary service in the container.
19   * </p>
20   * 
21   * @author <a href="mailto:founder_chen@yahoo.com.cn">Peter Cheng </a>
22   * @version $Revision: 1.2 $ $Date: 2004/10/13 10:31:16 $
23   * @version Revision: 1.0
24   */
25  
26  public interface ServiceEntry {
27      
28      /***
29       * Method addParameter
30       * 
31       * @param vParameter
32       */
33      public void addParameter(Parameter vParameter)
34              throws IndexOutOfBoundsException;
35  
36      /***
37       * Method addParameter
38       * 
39       * @param index
40       * @param vParameter
41       */
42      public void addParameter(int index,
43              org.huihoo.jfox.soaf.schema.service.Parameter vParameter)
44              throws IndexOutOfBoundsException;
45  
46      /***
47       * Method enumerateParameter
48       */
49      public Enumeration enumerateParameter();
50  
51      /***
52       * Method getDescriptionReturns the value of field 'description'.
53       * 
54       * @return the value of field 'description'.
55       */
56      public String getDescription();
57  
58      /***
59       * Method getIdReturns the value of field 'id'.
60       * 
61       * @return the value of field 'id'.
62       */
63      public String getId();
64  
65      /***
66       * Method getImplementationReturns the value of field 'implementation'.
67       * 
68       * @return the value of field 'implementation'.
69       */
70      public String getImplementation();
71  
72      /***
73       * Method getInterfaceReturns the value of field 'interface'.
74       * 
75       * @return the value of field 'interface'.
76       */
77      public String getInterface();
78  
79      /***
80       * Method getManageableReturns the value of field 'manageable'.
81       * 
82       * @return the value of field 'manageable'.
83       */
84      public String getManageable();
85  
86      /***
87       * Method getParameter
88       * 
89       * @param index
90       */
91      public Parameter getParameter(int index) throws IndexOutOfBoundsException;
92  
93      /***
94       * Method getParameter
95       */
96      public Parameter[] getParameter();
97  
98      /***
99       * Method getParameterCount
100      */
101     public int getParameterCount();
102 
103     /***
104      * Method isValid
105      */
106     public boolean isValid();
107 
108     /***
109      * Method marshal
110      * 
111      * @param out
112      */
113     public void marshal(java.io.Writer out)
114             throws org.exolab.castor.xml.MarshalException,
115             org.exolab.castor.xml.ValidationException;
116 
117     /***
118      * Method marshal
119      * 
120      * @param handler
121      */
122     public void marshal(org.xml.sax.ContentHandler handler)
123             throws java.io.IOException, org.exolab.castor.xml.MarshalException,
124             org.exolab.castor.xml.ValidationException;
125 
126     /***
127      * Method removeAllParameter
128      */
129     public void removeAllParameter();
130 
131     /***
132      * Method removeParameter
133      * 
134      * @param index
135      */
136     public Parameter removeParameter(int index);
137 
138     /***
139      * Method setDescriptionSets the value of field 'description'.
140      * 
141      * @param description
142      *            the value of field 'description'.
143      */
144     public void setDescription(String description);
145 
146     /***
147      * Method setIdSets the value of field 'id'.
148      * 
149      * @param id
150      *            the value of field 'id'.
151      */
152     public void setId(String id);
153 
154     /***
155      * Method setImplementationSets the value of field 'implementation'.
156      * 
157      * @param implementation
158      *            the value of field 'implementation'.
159      */
160     public void setImplementation(String implementation);
161 
162     /***
163      * Method setInterfaceSets the value of field 'interface'.
164      * 
165      * @param _interface
166      * @param interface
167      *            the value of field 'interface'.
168      */
169     public void setInterface(String _interface);
170 
171     /***
172      * Method setManageableSets the value of field 'manageable'.
173      * 
174      * @param manageable
175      *            the value of field 'manageable'.
176      */
177     public void setManageable(String manageable);
178 
179     /***
180      * Method setParameter
181      * 
182      * @param index
183      * @param vParameter
184      */
185     public void setParameter(int index, Parameter vParameter)
186             throws IndexOutOfBoundsException;
187 
188     /***
189      * Method setParameter
190      * 
191      * @param parameterArray
192      */
193     public void setParameter(Parameter[] parameterArray);
194 
195     /***
196      * Method validate
197      */
198     public void validate() throws org.exolab.castor.xml.ValidationException;
199 
200 }