From: mike <mike>
Date: Tue, 13 Dec 2005 15:30:26 +0000 (+0000)
Subject: Tweaks to Query documentation, add overview for Options.
X-Git-Tag: cpan_1_22~322
X-Git-Url: http://lists.indexdata.dk/?a=commitdiff_plain;h=5fd91c3a88f5d2d9e8f11f69ec620fba5dc15af0;p=ZOOM-Perl-moved-to-github.git

Tweaks to Query documentation, add overview for Options.
---

diff --git a/lib/ZOOM.pod b/lib/ZOOM.pod
index e21f7c5..337f080 100644
--- a/lib/ZOOM.pod
+++ b/lib/ZOOM.pod
@@ -1,4 +1,4 @@
-# $Id: ZOOM.pod,v 1.18 2005-12-13 14:53:08 mike Exp $
+# $Id: ZOOM.pod,v 1.19 2005-12-13 15:30:26 mike Exp $
 
 use strict;
 use warnings;
@@ -919,6 +919,10 @@ http://zing.z3950.org/cql/intro.html
 
 =back
 
+See the description of the C<Query> class in the ZOOM Abstract
+API at
+http://zoom.z3950.org/api/zoom-current.html#3.3
+
 =head3 Methods
 
 =head4 new()
@@ -941,7 +945,8 @@ is run on the query, the result is automatically sorted.  The sort
 specification language is the same as the C<yaz> sort-specification
 type of the C<ResultSet> method C<sort()>, described above.
 
-I<### It should be possible to sort by CQL query, too.>
+B<It ought to be possible to sort by CQL query, too, but at present
+limitations in the underlying ZOOM-C library make this impossible.>
 
 =head4 destroy()
 
@@ -952,6 +957,52 @@ reuse a Query that has been C<destroy()>ed.
 
 =head2 ZOOM::Options
 
+ $o1 = new ZOOM::Options();
+ $o1->option(user => "alf");
+ $o2 = new ZOOM::Options();
+ $o2->option(password => "fruit");
+ $opts = new ZOOM::Options($o1, $o2);
+ $conn = create ZOOM::Connection($opts);
+ $conn->connect($host);	# Uses the specified username and password
+
+Several classes of ZOOM objects carry their own sets of options, which
+can be manipulated using their C<option()> method.  Sometimes,
+however, it's useful to deal with the option sets directly, and the
+C<ZOOM::Options> class exists to enable this approach.
+
+Option sets are B<not currently described> in the ZOOM
+Abstract API at
+http://zoom.z3950.org/api/zoom-current.html
+They are an extension to that specification.
+
+=head3 Methods
+
+=head4 new()
+
+I<###>
+
+=head4 option()
+
+I<###>
+
+=head4 option_binary()
+
+I<###>
+
+=head4 bool() / int()
+
+I<###>
+
+=head4 set_int()
+
+I<###>
+
+=head4 set_callback()
+
+I<###>
+
+=head4 destroy()
+
 I<###>
 
 =head1 ENUMERATIONS