source: other-projects/trunk/gs3-webservices-democlient/docs/GS3DemoClient/org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html@ 15222

Last change on this file since 15222 was 15222, checked in by ak19, 16 years ago

Greenstone3 web services demo-clientadded to GS3's other-projects
File size: 61.0 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.5.0_10) on Sun Apr 27 20:47:14 NZST 2008 -->
6<TITLE>
7GS3ServicesAPIA
8</TITLE>
9
10<META NAME="keywords" CONTENT="org.greenstone.gs3client.dlservices.GS3ServicesAPIA class">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17 parent.document.title="GS3ServicesAPIA";
18}
19</SCRIPT>
20<NOSCRIPT>
21</NOSCRIPT>
22
23</HEAD>
24
25<BODY BGCOLOR="white" onload="windowTitle();">
26
27
28<!-- ========= START OF TOP NAVBAR ======= -->
29<A NAME="navbar_top"><!-- --></A>
30<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
32<TR>
33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
34<A NAME="navbar_top_firstrow"><!-- --></A>
35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
36 <TR ALIGN="center" VALIGN="top">
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
44 </TR>
45</TABLE>
46</TD>
47<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
48</EM>
49</TD>
50</TR>
51
52<TR>
53<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54&nbsp;<A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices"><B>PREV CLASS</B></A>&nbsp;
55&nbsp;<A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html" title="class in org.greenstone.gs3client.dlservices"><B>NEXT CLASS</B></A></FONT></TD>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../../../index.html?org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html" target="_top"><B>FRAMES</B></A> &nbsp;
58&nbsp;<A HREF="GS3ServicesAPIA.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
59&nbsp;<SCRIPT type="text/javascript">
60 <!--
61 if(window==top) {
62 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
63 }
64 //-->
65</SCRIPT>
66<NOSCRIPT>
67 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
68</NOSCRIPT>
69
70
71</FONT></TD>
72</TR>
73<TR>
74<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
75 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
76<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
77DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
78</TR>
79</TABLE>
80<A NAME="skip-navbar_top"></A>
81<!-- ========= END OF TOP NAVBAR ========= -->
82
83<HR>
84<!-- ======== START OF CLASS DATA ======== -->
85<H2>
86<FONT SIZE="-1">
87org.greenstone.gs3client.dlservices</FONT>
88<BR>
89Class GS3ServicesAPIA</H2>
90<PRE>
91java.lang.Object
92 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html" title="class in org.greenstone.gs3client.dlservices">org.greenstone.gs3client.dlservices.GS3WebServicesQBRAPI</A>
93 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.greenstone.gs3client.dlservices.GS3ServicesAPIA</B>
94</PRE>
95<DL>
96<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></DD>
97</DL>
98<HR>
99<DL>
100<DT><PRE>public class <B>GS3ServicesAPIA</B><DT>extends <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html" title="class in org.greenstone.gs3client.dlservices">GS3WebServicesQBRAPI</A><DT>implements <A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></DL>
101</PRE>
102
103<P>
104GS3ServicesAPIA does two things:
105 - it implements DigitalLibraryServicesAPIA for enabling the Java-client
106 to access Greenstone's repository of collections and documents. It
107 makes this possible through use of Greenstone 3's web services.
108 - it inherits from GS3WebServicesQBRAPI, which means it inherits all the
109 methods that deal with invoking the Greenstone 3 web services
110 functionality (through use of Apache Axis' Service and Call objects).
111 It therefore provides an equivalent method to each Greenstone 3 web
112 service operation, even if some of these web service operations are
113 never called by the Java-client and therefore not prescribed by the
114 DigitalLibraryServicesAPIA interface.
115<P>
116
117<P>
118<DL>
119<DT><B>Author:</B></DT>
120 <DD>ak19</DD>
121</DL>
122<HR>
123
124<P>
125<!-- ======== NESTED CLASS SUMMARY ======== -->
126
127<A NAME="nested_class_summary"><!-- --></A>
128<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
129<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
130<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
131<B>Nested Class Summary</B></FONT></TH>
132</TR>
133</TABLE>
134&nbsp;<A NAME="nested_classes_inherited_from_class_org.greenstone.gs3client.dlservices.DigitalLibraryServicesAPIA"><!-- --></A>
135<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
136<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
137<TH ALIGN="left"><B>Nested classes/interfaces inherited from interface org.greenstone.gs3client.dlservices.<A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></B></TH>
138</TR>
139<TR BGCOLOR="white" CLASS="TableRowColor">
140<TD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.CancelException.html" title="class in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA.CancelException</A></CODE></TD>
141</TR>
142</TABLE>
143&nbsp;
144<!-- =========== FIELD SUMMARY =========== -->
145
146<A NAME="field_summary"><!-- --></A>
147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
148<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
149<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
150<B>Field Summary</B></FONT></TH>
151</TR>
152<TR BGCOLOR="white" CLASS="TableRowColor">
153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
154<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
155<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#language">language</A></B></CODE>
156
157<BR>
158&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Storing language settings for requests and responses</TD>
159</TR>
160<TR BGCOLOR="white" CLASS="TableRowColor">
161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
162<CODE>(package private) static&nbsp;org.apache.log4j.Logger</CODE></FONT></TD>
163<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#LOG">LOG</A></B></CODE>
164
165<BR>
166&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Logger for this class</TD>
167</TR>
168</TABLE>
169&nbsp;<A NAME="fields_inherited_from_class_org.greenstone.gs3client.dlservices.GS3WebServicesQBRAPI"><!-- --></A>
170<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
171<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
172<TH ALIGN="left"><B>Fields inherited from class org.greenstone.gs3client.dlservices.<A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html" title="class in org.greenstone.gs3client.dlservices">GS3WebServicesQBRAPI</A></B></TH>
173</TR>
174<TR BGCOLOR="white" CLASS="TableRowColor">
175<TD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#call">call</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#defaultWsdlURL">defaultWsdlURL</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#namespace">namespace</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#portName">portName</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#service">service</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#serviceName">serviceName</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#wsdlURLName">wsdlURLName</A></CODE></TD>
176</TR>
177</TABLE>
178&nbsp;<A NAME="fields_inherited_from_class_org.greenstone.gs3client.dlservices.DigitalLibraryServicesAPIA"><!-- --></A>
179<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
180<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
181<TH ALIGN="left"><B>Fields inherited from interface org.greenstone.gs3client.dlservices.<A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></B></TH>
182</TR>
183<TR BGCOLOR="white" CLASS="TableRowColor">
184<TD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#propertiesFile">propertiesFile</A></CODE></TD>
185</TR>
186</TABLE>
187&nbsp;
188<!-- ======== CONSTRUCTOR SUMMARY ======== -->
189
190<A NAME="constructor_summary"><!-- --></A>
191<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
192<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
193<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
194<B>Constructor Summary</B></FONT></TH>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#GS3ServicesAPIA()">GS3ServicesAPIA</A></B>()</CODE>
198
199<BR>
200&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Displays a dialog to get user input for the location of the Greenstone 3
201 web services' WSDL file</TD>
202</TR>
203<TR BGCOLOR="white" CLASS="TableRowColor">
204<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#GS3ServicesAPIA(java.lang.String)">GS3ServicesAPIA</A></B>(java.lang.String&nbsp;wsdlURLName)</CODE>
205
206<BR>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;GS3ServicesAPIA constructor, which, given the url to the wsdl file,
208 finds either service and port or the service's endpoint of the GS3 Web
209 Services and instantiates the associated Service and Call objects.</TD>
210</TR>
211</TABLE>
212&nbsp;
213<!-- ========== METHOD SUMMARY =========== -->
214
215<A NAME="method_summary"><!-- --></A>
216<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
217<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
218<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
219<B>Method Summary</B></FONT></TH>
220</TR>
221<TR BGCOLOR="white" CLASS="TableRowColor">
222<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
223<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
224<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#describe()">describe</A></B>()</CODE>
225
226<BR>
227&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
228 contract</TD>
229</TR>
230<TR BGCOLOR="white" CLASS="TableRowColor">
231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
232<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
233<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#describeCollection(java.lang.String)">describeCollection</A></B>(java.lang.String&nbsp;collection)</CODE>
234
235<BR>
236&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
237 contract.</TD>
238</TR>
239<TR BGCOLOR="white" CLASS="TableRowColor">
240<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
241<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
242<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#describeCollectionService(java.lang.String, java.lang.String)">describeCollectionService</A></B>(java.lang.String&nbsp;collection,
243 java.lang.String&nbsp;service)</CODE>
244
245<BR>
246&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
247 contract.</TD>
248</TR>
249<TR BGCOLOR="white" CLASS="TableRowColor">
250<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
251<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
252<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#describeService(java.lang.String)">describeService</A></B>(java.lang.String&nbsp;service)</CODE>
253
254<BR>
255&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
256 contract.</TD>
257</TR>
258<TR BGCOLOR="white" CLASS="TableRowColor">
259<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
261<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#getAssocFileBaseURL()">getAssocFileBaseURL</A></B>()</CODE>
262
263<BR>
264&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
265 contract.</TD>
266</TR>
267<TR BGCOLOR="white" CLASS="TableRowColor">
268<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
270<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#getAssocFileBaseURL(org.greenstone.gs3client.data.DocumentNodeData)">getAssocFileBaseURL</A></B>(<A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>&nbsp;docNode)</CODE>
271
272<BR>
273&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
274 contract.</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
279<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#getDisplayName()">getDisplayName</A></B>()</CODE>
280
281<BR>
282&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
283</TR>
284<TR BGCOLOR="white" CLASS="TableRowColor">
285<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
286<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
287<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#getLanguage()">getLanguage</A></B>()</CODE>
288
289<BR>
290&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
291 contract.</TD>
292</TR>
293<TR BGCOLOR="white" CLASS="TableRowColor">
294<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
295<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
296<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#query(java.lang.String, java.lang.String, java.util.Map)">query</A></B>(java.lang.String&nbsp;collection,
297 java.lang.String&nbsp;service,
298 java.util.Map&nbsp;nameValParamsMap)</CODE>
299
300<BR>
301&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
302 contract.</TD>
303</TR>
304<TR BGCOLOR="white" CLASS="TableRowColor">
305<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
306<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
307<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String[])">retrieveBrowseMetadata</A></B>(java.lang.String&nbsp;collection,
308 java.lang.String&nbsp;service,
309 java.lang.String[]&nbsp;nodeIDs)</CODE>
310
311<BR>
312&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
313 contract.</TD>
314</TR>
315<TR BGCOLOR="white" CLASS="TableRowColor">
316<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
317<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
318<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#retrieveBrowseStructure(java.lang.String, java.lang.String, java.lang.String)">retrieveBrowseStructure</A></B>(java.lang.String&nbsp;collection,
319 java.lang.String&nbsp;service,
320 java.lang.String&nbsp;classifierID)</CODE>
321
322<BR>
323&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
324 contract.</TD>
325</TR>
326<TR BGCOLOR="white" CLASS="TableRowColor">
327<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
328<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
329<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#retrieveDocumentChildren(java.lang.String, java.lang.String)">retrieveDocumentChildren</A></B>(java.lang.String&nbsp;collection,
330 java.lang.String&nbsp;docID)</CODE>
331
332<BR>
333&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
334 contract.</TD>
335</TR>
336<TR BGCOLOR="white" CLASS="TableRowColor">
337<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
338<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
339<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#retrieveDocumentChildren(java.lang.String, java.lang.String[])">retrieveDocumentChildren</A></B>(java.lang.String&nbsp;collection,
340 java.lang.String[]&nbsp;docIDs)</CODE>
341
342<BR>
343&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
344 contract.</TD>
345</TR>
346<TR BGCOLOR="white" CLASS="TableRowColor">
347<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
348<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
349<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#retrieveDocumentContent(java.lang.String, java.lang.String)">retrieveDocumentContent</A></B>(java.lang.String&nbsp;collection,
350 java.lang.String&nbsp;docID)</CODE>
351
352<BR>
353&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
354 contract.</TD>
355</TR>
356<TR BGCOLOR="white" CLASS="TableRowColor">
357<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
358<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
359<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#retrieveDocumentContent(java.lang.String, java.lang.String[])">retrieveDocumentContent</A></B>(java.lang.String&nbsp;collection,
360 java.lang.String[]&nbsp;docIDs)</CODE>
361
362<BR>
363&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
364 contract.</TD>
365</TR>
366<TR BGCOLOR="white" CLASS="TableRowColor">
367<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
368<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
369<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#retrieveDocumentMetadata(java.lang.String, java.lang.String)">retrieveDocumentMetadata</A></B>(java.lang.String&nbsp;collection,
370 java.lang.String&nbsp;docID)</CODE>
371
372<BR>
373&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
374 contract.</TD>
375</TR>
376<TR BGCOLOR="white" CLASS="TableRowColor">
377<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
378<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
379<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#retrieveDocumentMetadata(java.lang.String, java.lang.String[])">retrieveDocumentMetadata</A></B>(java.lang.String&nbsp;collection,
380 java.lang.String[]&nbsp;docIDs)</CODE>
381
382<BR>
383&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
384 contract.</TD>
385</TR>
386<TR BGCOLOR="white" CLASS="TableRowColor">
387<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
388<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
389<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#retrieveDocumentStructure(java.lang.String, java.lang.String)">retrieveDocumentStructure</A></B>(java.lang.String&nbsp;collection,
390 java.lang.String&nbsp;docID)</CODE>
391
392<BR>
393&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
394 contract.</TD>
395</TR>
396<TR BGCOLOR="white" CLASS="TableRowColor">
397<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
398<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
399<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#retrieveDocumentStructure(java.lang.String, java.lang.String[])">retrieveDocumentStructure</A></B>(java.lang.String&nbsp;collection,
400 java.lang.String[]&nbsp;docIDs)</CODE>
401
402<BR>
403&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
404 contract.</TD>
405</TR>
406<TR BGCOLOR="white" CLASS="TableRowColor">
407<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
408<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
409<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#retrieveTitleMetadata(java.lang.String, java.lang.String)">retrieveTitleMetadata</A></B>(java.lang.String&nbsp;collection,
410 java.lang.String&nbsp;docID)</CODE>
411
412<BR>
413&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
414 contract.</TD>
415</TR>
416<TR BGCOLOR="white" CLASS="TableRowColor">
417<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
418<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
419<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#retrieveTitleMetadata(java.lang.String, java.lang.String[])">retrieveTitleMetadata</A></B>(java.lang.String&nbsp;collection,
420 java.lang.String[]&nbsp;docIDs)</CODE>
421
422<BR>
423&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
424 contract.</TD>
425</TR>
426<TR BGCOLOR="white" CLASS="TableRowColor">
427<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
428<CODE>&nbsp;void</CODE></FONT></TD>
429<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#setLanguage(java.lang.String)">setLanguage</A></B>(java.lang.String&nbsp;language)</CODE>
430
431<BR>
432&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
433 contract.</TD>
434</TR>
435<TR BGCOLOR="white" CLASS="TableRowColor">
436<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
437<CODE>static&nbsp;java.lang.String</CODE></FONT></TD>
438<TD><CODE><B><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html#showWsdlInputDialog()">showWsdlInputDialog</A></B>()</CODE>
439
440<BR>
441&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Static method that displays a dialog requesting the user to
442 input the location of Greenstone 3 web services' WSDL file.</TD>
443</TR>
444</TABLE>
445&nbsp;<A NAME="methods_inherited_from_class_org.greenstone.gs3client.dlservices.GS3WebServicesQBRAPI"><!-- --></A>
446<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
447<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
448<TH ALIGN="left"><B>Methods inherited from class org.greenstone.gs3client.dlservices.<A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html" title="class in org.greenstone.gs3client.dlservices">GS3WebServicesQBRAPI</A></B></TH>
449</TR>
450<TR BGCOLOR="white" CLASS="TableRowColor">
451<TD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#addArrayParam(java.lang.String)">addArrayParam</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#addStringParam(java.lang.String)">addStringParam</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#browse(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])">browse</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#browseDescendants(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])">browseDescendants</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#describe(java.lang.String, java.lang.String)">describe</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#describeCollection(java.lang.String, java.lang.String, java.lang.String)">describeCollection</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#describeCollectionService(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">describeCollectionService</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#describeService(java.lang.String, java.lang.String, java.lang.String)">describeService</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#describeServiceCluster(java.lang.String, java.lang.String, java.lang.String)">describeServiceCluster</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getElementsByTagNameNS(org.w3c.dom.Element, java.lang.String, java.lang.String)">getElementsByTagNameNS</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getElementsByTagNameNS(org.w3c.dom.Element, java.lang.String, java.lang.String, java.util.Vector)">getElementsByTagNameNS</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getElementsByTagNameSuffix(org.w3c.dom.Element, java.lang.String, java.util.Vector)">getElementsByTagNameSuffix</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getNamespace()">getNamespace</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getPort()">getPort</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getService()">getService</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#getWsdl()">getWsdl</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#help()">help</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#helpWithMethod(java.lang.String)">helpWithMethod</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#invokeWith(java.lang.Object[])">invokeWith</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#main(java.lang.String[])">main</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#query(java.lang.String, java.lang.String, java.lang.String, java.util.Map)">query</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveAllBrowseMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])">retrieveAllBrowseMetadata</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveAllDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[])">retrieveAllDocumentMetadata</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])">retrieveBrowseMetadata</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveDocumentContent(java.lang.String, java.lang.String, java.lang.String[])">retrieveDocumentContent</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveDocumentMetadata(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[])">retrieveDocumentMetadata</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveDocumentStructure(java.lang.String, java.lang.String, java.lang.String[], java.lang.String[], java.lang.String[])">retrieveDocumentStructure</A>, <A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html#retrieveEntireDocumentStructure(java.lang.String, java.lang.String, java.lang.String[])">retrieveEntireDocumentStructure</A></CODE></TD>
452</TR>
453</TABLE>
454&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
455<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
456<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
457<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
458</TR>
459<TR BGCOLOR="white" CLASS="TableRowColor">
460<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
461</TR>
462</TABLE>
463&nbsp;
464<P>
465
466<!-- ============ FIELD DETAIL =========== -->
467
468<A NAME="field_detail"><!-- --></A>
469<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
470<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
471<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
472<B>Field Detail</B></FONT></TH>
473</TR>
474</TABLE>
475
476<A NAME="LOG"><!-- --></A><H3>
477LOG</H3>
478<PRE>
479static org.apache.log4j.Logger <B>LOG</B></PRE>
480<DL>
481<DD>The Logger for this class
482<P>
483<DL>
484</DL>
485</DL>
486<HR>
487
488<A NAME="language"><!-- --></A><H3>
489language</H3>
490<PRE>
491protected java.lang.String <B>language</B></PRE>
492<DL>
493<DD>Storing language settings for requests and responses
494<P>
495<DL>
496</DL>
497</DL>
498
499<!-- ========= CONSTRUCTOR DETAIL ======== -->
500
501<A NAME="constructor_detail"><!-- --></A>
502<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
503<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
504<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
505<B>Constructor Detail</B></FONT></TH>
506</TR>
507</TABLE>
508
509<A NAME="GS3ServicesAPIA()"><!-- --></A><H3>
510GS3ServicesAPIA</H3>
511<PRE>
512public <B>GS3ServicesAPIA</B>()
513 throws javax.xml.rpc.ServiceException,
514 java.net.MalformedURLException,
515 javax.xml.parsers.ParserConfigurationException,
516 java.io.IOException,
517 java.lang.Exception</PRE>
518<DL>
519<DD>Displays a dialog to get user input for the location of the Greenstone 3
520 web services' WSDL file
521<P>
522<DL>
523
524<DT><B>Throws:</B>
525<DD><CODE>javax.xml.rpc.ServiceException</CODE>
526<DD><CODE>java.net.MalformedURLException</CODE>
527<DD><CODE>javax.xml.parsers.ParserConfigurationException</CODE>
528<DD><CODE>java.io.IOException</CODE>
529<DD><CODE>java.lang.Exception</CODE></DL>
530</DL>
531<HR>
532
533<A NAME="GS3ServicesAPIA(java.lang.String)"><!-- --></A><H3>
534GS3ServicesAPIA</H3>
535<PRE>
536public <B>GS3ServicesAPIA</B>(java.lang.String&nbsp;wsdlURLName)
537 throws javax.xml.rpc.ServiceException,
538 java.net.MalformedURLException,
539 javax.xml.parsers.ParserConfigurationException,
540 java.io.IOException,
541 org.xml.sax.SAXException</PRE>
542<DL>
543<DD>GS3ServicesAPIA constructor, which, given the url to the wsdl file,
544 finds either service and port or the service's endpoint of the GS3 Web
545 Services and instantiates the associated Service and Call objects.
546<P>
547<DL>
548<DT><B>Parameters:</B><DD><CODE>wsdlURLName</CODE> - - location of the WSDL for Greenstone 3's
549 web services
550<DT><B>Throws:</B>
551<DD><CODE>javax.xml.rpc.ServiceException</CODE>
552<DD><CODE>java.net.MalformedURLException</CODE>
553<DD><CODE>javax.xml.parsers.ParserConfigurationException</CODE>
554<DD><CODE>java.io.IOException</CODE>
555<DD><CODE>org.xml.sax.SAXException</CODE></DL>
556</DL>
557
558<!-- ============ METHOD DETAIL ========== -->
559
560<A NAME="method_detail"><!-- --></A>
561<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
562<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
563<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
564<B>Method Detail</B></FONT></TH>
565</TR>
566</TABLE>
567
568<A NAME="showWsdlInputDialog()"><!-- --></A><H3>
569showWsdlInputDialog</H3>
570<PRE>
571public static java.lang.String <B>showWsdlInputDialog</B>()
572 throws java.lang.Exception</PRE>
573<DL>
574<DD>Static method that displays a dialog requesting the user to
575 input the location of Greenstone 3 web services' WSDL file.
576<P>
577<DD><DL>
578</DL>
579</DD>
580<DD><DL>
581
582<DT><B>Returns:</B><DD>a String representing the URL location of Greenstone 3 web
583 services' WSDL file
584<DT><B>Throws:</B>
585<DD><CODE>java.lang.Exception</CODE></DL>
586</DD>
587</DL>
588<HR>
589
590<A NAME="getDisplayName()"><!-- --></A><H3>
591getDisplayName</H3>
592<PRE>
593public java.lang.String <B>getDisplayName</B>()</PRE>
594<DL>
595<DD><DL>
596<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#getDisplayName()">getDisplayName</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
597</DD>
598<DD><DL>
599
600<DT><B>Returns:</B><DD>the name of this digital library for displaying in the client</DL>
601</DD>
602</DL>
603<HR>
604
605<A NAME="setLanguage(java.lang.String)"><!-- --></A><H3>
606setLanguage</H3>
607<PRE>
608public void <B>setLanguage</B>(java.lang.String&nbsp;language)</PRE>
609<DL>
610<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
611 contract.
612 Sets the preferred language (code) for metadata and other content to be
613 returned on request messages. If the preferred language is not available,
614 the implementation may choose to send English back instead, or failing
615 that, send the data in any other available language.
616<P>
617<DD><DL>
618<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#setLanguage(java.lang.String)">setLanguage</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
619</DD>
620<DD><DL>
621<DT><B>Parameters:</B><DD><CODE>language</CODE> - has to be a language code as recognised by Greenstone3
622 (the language codes used by W3C probably). E.g. "en" for English.</DL>
623</DD>
624</DL>
625<HR>
626
627<A NAME="getLanguage()"><!-- --></A><H3>
628getLanguage</H3>
629<PRE>
630public java.lang.String <B>getLanguage</B>()</PRE>
631<DL>
632<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
633 contract.
634 Gets the language that's set as the preferred language.
635<P>
636<DD><DL>
637<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#getLanguage()">getLanguage</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
638</DD>
639<DD><DL>
640
641<DT><B>Returns:</B><DD>the language code as recognised by Greenstone3 (which are the
642 language codes used by W3C probably). E.g. "en" for English.</DL>
643</DD>
644</DL>
645<HR>
646
647<A NAME="getAssocFileBaseURL()"><!-- --></A><H3>
648getAssocFileBaseURL</H3>
649<PRE>
650public java.lang.String <B>getAssocFileBaseURL</B>()</PRE>
651<DL>
652<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
653 contract.
654<P>
655<DD><DL>
656<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#getAssocFileBaseURL()">getAssocFileBaseURL</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
657</DD>
658<DD><DL>
659
660<DT><B>Returns:</B><DD>the overall directory path for associated files (not including
661 the document's nodeID/pid). This can be used to *formulate* the base url
662 of JEditorPane's HTML documents. If the documents from any digital library
663 do not contain relative paths, or otherwise deal with the resolution of
664 relative urls themselves, then return "" from here.</DL>
665</DD>
666</DL>
667<HR>
668
669<A NAME="getAssocFileBaseURL(org.greenstone.gs3client.data.DocumentNodeData)"><!-- --></A><H3>
670getAssocFileBaseURL</H3>
671<PRE>
672public java.lang.String <B>getAssocFileBaseURL</B>(<A HREF="../../../../org/greenstone/gs3client/data/DocumentNodeData.html" title="class in org.greenstone.gs3client.data">DocumentNodeData</A>&nbsp;docNode)</PRE>
673<DL>
674<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
675 contract.
676<P>
677<DD><DL>
678<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#getAssocFileBaseURL(org.greenstone.gs3client.data.DocumentNodeData)">getAssocFileBaseURL</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
679</DD>
680<DD><DL>
681
682<DT><B>Returns:</B><DD>the directory path to the associated files of the given document
683 node. For instance, the base url of a JEditorPane's HTML documents can be
684 set to this.</DL>
685</DD>
686</DL>
687<HR>
688
689<A NAME="describe()"><!-- --></A><H3>
690describe</H3>
691<PRE>
692public java.lang.String <B>describe</B>()</PRE>
693<DL>
694<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
695 contract
696<P>
697<DD><DL>
698<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#describe()">describe</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
699</DD>
700<DD><DL>
701
702<DT><B>Returns:</B><DD>Greenstone3 XML describe response message originating from
703 the Message Router, describing the Collections, ServiceRacks
704 and Services supported by the Message Router for all collections.</DL>
705</DD>
706</DL>
707<HR>
708
709<A NAME="describeCollection(java.lang.String)"><!-- --></A><H3>
710describeCollection</H3>
711<PRE>
712public java.lang.String <B>describeCollection</B>(java.lang.String&nbsp;collection)</PRE>
713<DL>
714<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
715 contract.
716<P>
717<DD><DL>
718<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#describeCollection(java.lang.String)">describeCollection</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
719</DD>
720<DD><DL>
721<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection to be described.
722<DT><B>Returns:</B><DD>Greenstone3 XML describe response message originating from a
723 collection, describing the collection (display items) as well as
724 listing any services supported specifically by the collection.</DL>
725</DD>
726</DL>
727<HR>
728
729<A NAME="describeCollectionService(java.lang.String, java.lang.String)"><!-- --></A><H3>
730describeCollectionService</H3>
731<PRE>
732public java.lang.String <B>describeCollectionService</B>(java.lang.String&nbsp;collection,
733 java.lang.String&nbsp;service)</PRE>
734<DL>
735<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
736 contract.
737<P>
738<DD><DL>
739<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#describeCollectionService(java.lang.String, java.lang.String)">describeCollectionService</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
740</DD>
741<DD><DL>
742<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection to be described.<DD><CODE>service</CODE> - is the name of the collection's service to be described.
743<DT><B>Returns:</B><DD>Greenstone3 XML describe response message originating from a
744 collection's service, describing the service (display items).</DL>
745</DD>
746</DL>
747<HR>
748
749<A NAME="describeService(java.lang.String)"><!-- --></A><H3>
750describeService</H3>
751<PRE>
752public java.lang.String <B>describeService</B>(java.lang.String&nbsp;service)</PRE>
753<DL>
754<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
755 contract.
756<P>
757<DD><DL>
758<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#describeService(java.lang.String)">describeService</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
759</DD>
760<DD><DL>
761<DT><B>Parameters:</B><DD><CODE>service</CODE> - is the name of the collection's service to be described.
762<DT><B>Returns:</B><DD>Greenstone3 XML describe response message originating from a
763 general (non-collection specific) service, describing the requested
764 service (for example with GS3 display items).</DL>
765</DD>
766</DL>
767<HR>
768
769<A NAME="retrieveDocumentContent(java.lang.String, java.lang.String[])"><!-- --></A><H3>
770retrieveDocumentContent</H3>
771<PRE>
772public java.lang.String <B>retrieveDocumentContent</B>(java.lang.String&nbsp;collection,
773 java.lang.String[]&nbsp;docIDs)</PRE>
774<DL>
775<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
776 contract.
777<P>
778<DD><DL>
779<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentContent(java.lang.String, java.lang.String[])">retrieveDocumentContent</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
780</DD>
781<DD><DL>
782<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection.<DD><CODE>docIDs</CODE> - is an array of document identifiers of documents whose (text)
783 contents are requested.
784<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentContentRetrieve XML
785 containing the document contents of the documents indicated by docIDs</DL>
786</DD>
787</DL>
788<HR>
789
790<A NAME="retrieveDocumentContent(java.lang.String, java.lang.String)"><!-- --></A><H3>
791retrieveDocumentContent</H3>
792<PRE>
793public java.lang.String <B>retrieveDocumentContent</B>(java.lang.String&nbsp;collection,
794 java.lang.String&nbsp;docID)</PRE>
795<DL>
796<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
797 contract.
798<P>
799<DD><DL>
800<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentContent(java.lang.String, java.lang.String)">retrieveDocumentContent</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
801</DD>
802<DD><DL>
803<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection.<DD><CODE>docID</CODE> - is the document identifier of the document whose (text)
804 content is requested.
805<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentContentRetrieve XML
806 containing the document contents of the document indicated by docID</DL>
807</DD>
808</DL>
809<HR>
810
811<A NAME="retrieveDocumentMetadata(java.lang.String, java.lang.String[])"><!-- --></A><H3>
812retrieveDocumentMetadata</H3>
813<PRE>
814public java.lang.String <B>retrieveDocumentMetadata</B>(java.lang.String&nbsp;collection,
815 java.lang.String[]&nbsp;docIDs)</PRE>
816<DL>
817<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
818 contract.
819<P>
820<DD><DL>
821<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentMetadata(java.lang.String, java.lang.String[])">retrieveDocumentMetadata</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
822</DD>
823<DD><DL>
824<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection.<DD><CODE>docIDs</CODE> - is an array of document identifiers of documents whose
825 metadata is requested.
826<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
827 containing all the metadata of all the documents indicated by docIDs</DL>
828</DD>
829</DL>
830<HR>
831
832<A NAME="retrieveDocumentMetadata(java.lang.String, java.lang.String)"><!-- --></A><H3>
833retrieveDocumentMetadata</H3>
834<PRE>
835public java.lang.String <B>retrieveDocumentMetadata</B>(java.lang.String&nbsp;collection,
836 java.lang.String&nbsp;docID)</PRE>
837<DL>
838<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
839 contract.
840<P>
841<DD><DL>
842<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentMetadata(java.lang.String, java.lang.String)">retrieveDocumentMetadata</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
843</DD>
844<DD><DL>
845<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection.<DD><CODE>docID</CODE> - is the document identifier of the document whose metadata is
846 requested.
847<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
848 containing all the metadata of the document denoted by docID</DL>
849</DD>
850</DL>
851<HR>
852
853<A NAME="retrieveTitleMetadata(java.lang.String, java.lang.String[])"><!-- --></A><H3>
854retrieveTitleMetadata</H3>
855<PRE>
856public java.lang.String <B>retrieveTitleMetadata</B>(java.lang.String&nbsp;collection,
857 java.lang.String[]&nbsp;docIDs)</PRE>
858<DL>
859<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
860 contract.
861<P>
862<DD><DL>
863<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveTitleMetadata(java.lang.String, java.lang.String[])">retrieveTitleMetadata</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
864</DD>
865<DD><DL>
866<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection.<DD><CODE>docIDs</CODE> - is an array of document identifiers of documents whose titles
867 are requested
868<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
869 containing only the title metadata of the documents denoted by docIDs</DL>
870</DD>
871</DL>
872<HR>
873
874<A NAME="retrieveTitleMetadata(java.lang.String, java.lang.String)"><!-- --></A><H3>
875retrieveTitleMetadata</H3>
876<PRE>
877public java.lang.String <B>retrieveTitleMetadata</B>(java.lang.String&nbsp;collection,
878 java.lang.String&nbsp;docID)</PRE>
879<DL>
880<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
881 contract.
882<P>
883<DD><DL>
884<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveTitleMetadata(java.lang.String, java.lang.String)">retrieveTitleMetadata</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
885</DD>
886<DD><DL>
887<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docID</CODE> - is the document identifier of the document whose titles is
888 requested
889<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
890 containing only the title metadata of the document denoted by docID</DL>
891</DD>
892</DL>
893<HR>
894
895<A NAME="retrieveDocumentStructure(java.lang.String, java.lang.String[])"><!-- --></A><H3>
896retrieveDocumentStructure</H3>
897<PRE>
898public java.lang.String <B>retrieveDocumentStructure</B>(java.lang.String&nbsp;collection,
899 java.lang.String[]&nbsp;docIDs)</PRE>
900<DL>
901<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
902 contract.
903<P>
904<DD><DL>
905<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentStructure(java.lang.String, java.lang.String[])">retrieveDocumentStructure</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
906</DD>
907<DD><DL>
908<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docIDs</CODE> - is an array of document identifiers of documents whose
909 hierarchical structures are requested
910<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
911 containing the document structure of the documents indicated by docIDs:
912 this means all their descendants</DL>
913</DD>
914</DL>
915<HR>
916
917<A NAME="retrieveDocumentStructure(java.lang.String, java.lang.String)"><!-- --></A><H3>
918retrieveDocumentStructure</H3>
919<PRE>
920public java.lang.String <B>retrieveDocumentStructure</B>(java.lang.String&nbsp;collection,
921 java.lang.String&nbsp;docID)</PRE>
922<DL>
923<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
924 contract.
925<P>
926<DD><DL>
927<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentStructure(java.lang.String, java.lang.String)">retrieveDocumentStructure</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
928</DD>
929<DD><DL>
930<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docID</CODE> - is the document identifier of the document whose hierarchical
931 structure is requested
932<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
933 containing the document structure of the document indicated by docID:
934 this means all its descendants</DL>
935</DD>
936</DL>
937<HR>
938
939<A NAME="retrieveDocumentChildren(java.lang.String, java.lang.String[])"><!-- --></A><H3>
940retrieveDocumentChildren</H3>
941<PRE>
942public java.lang.String <B>retrieveDocumentChildren</B>(java.lang.String&nbsp;collection,
943 java.lang.String[]&nbsp;docIDs)</PRE>
944<DL>
945<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
946 contract.
947<P>
948<DD><DL>
949<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentChildren(java.lang.String, java.lang.String[])">retrieveDocumentChildren</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
950</DD>
951<DD><DL>
952<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docIDs</CODE> - is an array of document identifiers of documents whose
953 hierarchical structures are requested
954<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
955 containing a view of the document structure of the documents denoted by
956 docs where only the requested documents and their direct children are
957 returned.</DL>
958</DD>
959</DL>
960<HR>
961
962<A NAME="retrieveDocumentChildren(java.lang.String, java.lang.String)"><!-- --></A><H3>
963retrieveDocumentChildren</H3>
964<PRE>
965public java.lang.String <B>retrieveDocumentChildren</B>(java.lang.String&nbsp;collection,
966 java.lang.String&nbsp;docID)</PRE>
967<DL>
968<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
969 contract.
970<P>
971<DD><DL>
972<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveDocumentChildren(java.lang.String, java.lang.String)">retrieveDocumentChildren</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
973</DD>
974<DD><DL>
975<DT><B>Parameters:</B><DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>docID</CODE> - is the document identifier of the document whose hierarchical
976 structure is requested
977<DT><B>Returns:</B><DD>a String representing Greenstone3 DocumentMetadataRetrieve XML
978 containing a view of the document structure of the document denoted by
979 docID where only the document and its direct children are returned.</DL>
980</DD>
981</DL>
982<HR>
983
984<A NAME="retrieveBrowseStructure(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
985retrieveBrowseStructure</H3>
986<PRE>
987public java.lang.String <B>retrieveBrowseStructure</B>(java.lang.String&nbsp;collection,
988 java.lang.String&nbsp;service,
989 java.lang.String&nbsp;classifierID)</PRE>
990<DL>
991<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
992 contract.
993<P>
994<DD><DL>
995<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveBrowseStructure(java.lang.String, java.lang.String, java.lang.String)">retrieveBrowseStructure</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
996</DD>
997<DD><DL>
998<DT><B>Parameters:</B><DD><CODE>classifierID</CODE> - is of the form CL# where the number (#) marks
999 out structured sections like CL1.1.3 or CL2<DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>service</CODE> - is the name of the browse service (=ClassifierBrowse usually)
1000<DT><B>Returns:</B><DD>a String representing Greenstone3 ClassifierBrowse XML
1001 giving the entire *structure* of the classification denoted by
1002 classifierID (including the structures of document descendants of
1003 the classifier).</DL>
1004</DD>
1005</DL>
1006<HR>
1007
1008<A NAME="retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String[])"><!-- --></A><H3>
1009retrieveBrowseMetadata</H3>
1010<PRE>
1011public java.lang.String <B>retrieveBrowseMetadata</B>(java.lang.String&nbsp;collection,
1012 java.lang.String&nbsp;service,
1013 java.lang.String[]&nbsp;nodeIDs)</PRE>
1014<DL>
1015<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
1016 contract.
1017<P>
1018<DD><DL>
1019<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#retrieveBrowseMetadata(java.lang.String, java.lang.String, java.lang.String[])">retrieveBrowseMetadata</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
1020</DD>
1021<DD><DL>
1022<DT><B>Parameters:</B><DD><CODE>nodeIDs</CODE> - is of the form CL#.# where the number (#) marks
1023 out structured sections like CL2.1.3. NodeIDs are generally subsections
1024 of top-level classifierNodes (CL#, e.g. CL3).<DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>service</CODE> - is the name of the Browse's MetadataRetrieve service
1025 (usually the browse service is ClassifierBrowse, in which case it always
1026 has a retrieve service called ClassifierBrowseMetadataRetrieve)
1027<DT><B>Returns:</B><DD>a String representing Greenstone3
1028 ClassifierBrowseMetadataRetrieve XML giving all the metadata for
1029 all the subclassifiers denoted by nodeIDs.</DL>
1030</DD>
1031</DL>
1032<HR>
1033
1034<A NAME="query(java.lang.String, java.lang.String, java.util.Map)"><!-- --></A><H3>
1035query</H3>
1036<PRE>
1037public java.lang.String <B>query</B>(java.lang.String&nbsp;collection,
1038 java.lang.String&nbsp;service,
1039 java.util.Map&nbsp;nameValParamsMap)</PRE>
1040<DL>
1041<DD>Part of the GS3 Java-Client's DigitalLibraryServicesAPIA interface
1042 contract.
1043<P>
1044<DD><DL>
1045<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html#query(java.lang.String, java.lang.String, java.util.Map)">query</A></CODE> in interface <CODE><A HREF="../../../../org/greenstone/gs3client/dlservices/DigitalLibraryServicesAPIA.html" title="interface in org.greenstone.gs3client.dlservices">DigitalLibraryServicesAPIA</A></CODE></DL>
1046</DD>
1047<DD><DL>
1048<DT><B>Parameters:</B><DD><CODE>nameValParamsMap</CODE> - is a Map of name and value pairs for all the
1049 query field data values. The names match the field names that
1050 describeCollectionService() would have returned for the query service.<DD><CODE>collection</CODE> - is the name of the collection<DD><CODE>service</CODE> - is the name of the query service
1051<DT><B>Returns:</B><DD>a String representing Greenstone3 XML for a query process
1052 response returning the results for the query denoted by parameter
1053 nameValParamsMap.</DL>
1054</DD>
1055</DL>
1056<!-- ========= END OF CLASS DATA ========= -->
1057<HR>
1058
1059
1060<!-- ======= START OF BOTTOM NAVBAR ====== -->
1061<A NAME="navbar_bottom"><!-- --></A>
1062<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1063<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1064<TR>
1065<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1066<A NAME="navbar_bottom_firstrow"><!-- --></A>
1067<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1068 <TR ALIGN="center" VALIGN="top">
1069 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1070 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1071 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1072 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1073 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1074 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1075 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1076 </TR>
1077</TABLE>
1078</TD>
1079<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1080</EM>
1081</TD>
1082</TR>
1083
1084<TR>
1085<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1086&nbsp;<A HREF="../../../../org/greenstone/gs3client/dlservices/FedoraServicesAPIA.html" title="class in org.greenstone.gs3client.dlservices"><B>PREV CLASS</B></A>&nbsp;
1087&nbsp;<A HREF="../../../../org/greenstone/gs3client/dlservices/GS3WebServicesQBRAPI.html" title="class in org.greenstone.gs3client.dlservices"><B>NEXT CLASS</B></A></FONT></TD>
1088<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1089 <A HREF="../../../../index.html?org/greenstone/gs3client/dlservices/GS3ServicesAPIA.html" target="_top"><B>FRAMES</B></A> &nbsp;
1090&nbsp;<A HREF="GS3ServicesAPIA.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
1091&nbsp;<SCRIPT type="text/javascript">
1092 <!--
1093 if(window==top) {
1094 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
1095 }
1096 //-->
1097</SCRIPT>
1098<NOSCRIPT>
1099 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
1100</NOSCRIPT>
1101
1102
1103</FONT></TD>
1104</TR>
1105<TR>
1106<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1107 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1108<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1109DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1110</TR>
1111</TABLE>
1112<A NAME="skip-navbar_bottom"></A>
1113<!-- ======== END OF BOTTOM NAVBAR ======= -->
1114
1115<HR>
1116
1117</BODY>
1118</HTML>
Note: See TracBrowser for help on using the repository browser.