Java > Open Source Codes > org > mmbase > applications > packaging > packagehandlers > PackageInterface


1 /*
2  * This software is OSI Certified Open Source Software.
3  * OSI Certified is a certification mark of the Open Source Initiative.
4  * The license (Mozilla version 1.0) can be read at the MMBase site.
5  * See http://www.MMBase.org/license
6  */
7 package org.mmbase.applications.packaging.packagehandlers;
8
9 import java.io.BufferedInputStream ;
10 import java.util.Iterator ;
11 import java.util.List ;
12 import java.util.jar.JarFile ;
13
14 import org.mmbase.applications.packaging.bundlehandlers.BundleInterface;
15 import org.mmbase.applications.packaging.installhandlers.installStep;
16 import org.mmbase.applications.packaging.providerhandlers.ProviderInterface;
17
18 /**
19  * Interface for all the package handlers
20  *
21  * @author danielockeloen
22  */
23 public interface PackageInterface {
24     /**
25      * Description of the Method
26      *
27      * @param n Description of the Parameter
28      * @param provider Description of the Parameter
29      * @param name Description of the Parameter
30      * @param type Description of the Parameter
31      * @param maintainer Description of the Parameter
32      * @param version Description of the Parameter
33      * @param date Description of the Parameter
34      * @param path Description of the Parameter
35      */
36     public void init(org.w3c.dom.Node n, ProviderInterface provider, String name, String type, String maintainer, String version, String date, String path);
37
38
39     /**
40      * Gets the id attribute of the PackageInterface object
41      *
42      * @return The id value
43      */
44     public String getId();
45
46
47     /**
48      * Gets the name attribute of the PackageInterface object
49      *
50      * @return The name value
51      */
52     public String getName();
53
54
55     /**
56      * Gets the type attribute of the PackageInterface object
57      *
58      * @return The type value
59      */
60     public String getType();
61
62
63     /**
64      * Gets the version attribute of the PackageInterface object
65      *
66      * @return The version value
67      */
68     public String getVersion();
69
70
71     /**
72      * Gets the creationDate attribute of the PackageInterface object
73      *
74      * @return The creationDate value
75      */
76     public String getCreationDate();
77
78
79     /**
80      * Gets the maintainer attribute of the PackageInterface object
81      *
82      * @return The maintainer value
83      */
84     public String getMaintainer();
85
86
87     /**
88      * Gets the state attribute of the PackageInterface object
89      *
90      * @return The state value
91      */
92     public String getState();
93
94
95     /**
96      * Gets the description attribute of the PackageInterface object
97      *
98      * @return The description value
99      */
100     public String getDescription();
101
102
103     /**
104      * Gets the installationNotes attribute of the PackageInterface object
105      *
106      * @return The installationNotes value
107      */
108     public String getInstallationNotes();
109
110
111     /**
112      * Gets the releaseNotes attribute of the PackageInterface object
113      *
114      * @return The releaseNotes value
115      */
116     public String getReleaseNotes();
117
118
119     /**
120      * Gets the licenseType attribute of the PackageInterface object
121      *
122      * @return The licenseType value
123      */
124     public String getLicenseType();
125
126
127     /**
128      * Gets the licenseName attribute of the PackageInterface object
129      *
130      * @return The licenseName value
131      */
132     public String getLicenseName();
133
134
135     /**
136      * Gets the licenseVersion attribute of the PackageInterface object
137      *
138      * @return The licenseVersion value
139      */
140     public String getLicenseVersion();
141
142
143     /**
144      * Gets the licenseBody attribute of the PackageInterface object
145      *
146      * @return The licenseBody value
147      */
148     public String getLicenseBody();
149
150
151     /**
152      * Gets the relatedPeople attribute of the PackageInterface object
153      *
154      * @param type Description of the Parameter
155      * @return The relatedPeople value
156      */
157     public List getRelatedPeople(String type);
158
159
160     /**
161      * Gets the parentBundle attribute of the PackageInterface object
162      *
163      * @return The parentBundle value
164      */
165     public BundleInterface getParentBundle();
166
167
168     /**
169      * Sets the parentBundle attribute of the PackageInterface object
170      *
171      * @param parent The new parentBundle value
172      */
173     public void setParentBundle(BundleInterface parent);
174
175
176     /**
177      * Sets the state attribute of the PackageInterface object
178      *
179      * @param state The new state value
180      * @return Description of the Return Value
181      */
182     public boolean setState(String state);
183
184
185     /**
186      * Description of the Method
187      *
188      * @return Description of the Return Value
189      */
190     public boolean install();
191
192
193     /**
194      * Description of the Method
195      *
196      * @return Description of the Return Value
197      */
198     public boolean uninstall();
199
200
201     /**
202      * Description of the Method
203      *
204      * @param step Description of the Parameter
205      * @return Description of the Return Value
206      */
207     public boolean install(installStep step);
208
209
210     /**
211      * Description of the Method
212      *
213      * @param step Description of the Parameter
214      * @return Description of the Return Value
215      */
216     public boolean uninstall(installStep step);
217
218
219     /**
220      * Gets the provider attribute of the PackageInterface object
221      *
222      * @return The provider value
223      */
224     public ProviderInterface getProvider();
225
226
227     /**
228      * Gets the installSteps attribute of the PackageInterface object
229      *
230      * @return The installSteps value
231      */
232     public Iterator getInstallSteps();
233
234
235     /**
236      * Gets the installSteps attribute of the PackageInterface object
237      *
238      * @param logid Description of the Parameter
239      * @return The installSteps value
240      */
241     public Iterator getInstallSteps(int logid);
242
243
244     /**
245      * Description of the Method
246      */
247     public void clearInstallSteps();
248
249
250     /**
251      * Gets the jarFile attribute of the PackageInterface object
252      *
253      * @return The jarFile value
254      */
255     public JarFile getJarFile();
256
257
258     /**
259      * Gets the jarStream attribute of the PackageInterface object
260      *
261      * @return The jarStream value
262      */
263     public BufferedInputStream getJarStream();
264
265
266     /**
267      * Gets the path attribute of the PackageInterface object
268      *
269      * @return The path value
270      */
271     public String getPath();
272
273
274     /**
275      * Gets the dependsFailed attribute of the PackageInterface object
276      *
277      * @return The dependsFailed value
278      */
279     public boolean getDependsFailed();
280
281
282     /**
283      * Gets the progressBarValue attribute of the PackageInterface object
284      *
285      * @return The progressBarValue value
286      */
287     public int getProgressBarValue();
288
289
290     /**
291      * Sets the progressBar attribute of the PackageInterface object
292      *
293      * @param stepcount The new progressBar value
294      */
295     public void setProgressBar(int stepcount);
296
297
298     /**
299      * Description of the Method
300      */
301     public void increaseProgressBar();
302
303
304     /**
305      * Description of the Method
306      *
307      * @param stepcount Description of the Parameter
308      */
309     public void increaseProgressBar(int stepcount);
310
311 }
312
313

A to Z: JavaDoc & Examples

---

Daily Java News & Articles

---

Open Source Projects

---

Open Source Codes

---

Free Computer Books

---

Remove Frame

---

Popular Tags