Changeset 6601 for trunk/DataStore/lib/DataStore/FileSet.pm

Timestamp:

Mar 15, 2006, 4:47:09 PM (20 years ago)

Author:

jhoblitt

Message:

doc update

File:

• trunk/DataStore/lib/DataStore/FileSet.pm (modified) (5 diffs)

trunk/DataStore/lib/DataStore/FileSet.pm

@@ -1 +1 @@
 # Copyright (C) 2006  Joshua Hoblitt
 #
-# $Id: FileSet.pm,v 1.3 2006-03-15 03:18:25 jhoblitt Exp $
+# $Id: FileSet.pm,v 1.4 2006-03-16 02:47:09 jhoblitt Exp $
 
 package DataStore::FileSet;
@@ -35 +35 @@
     use DataStore::FileSet;
 
-    my $dsfs = DateStore::FileSet->new(...);
+    my $dsfs = DateStore::FileSet->new(
+        uri         => 'http://example.org/',
+        fileset     => '12buckelyourshoe',
+        datetime    => '2042-01-01T00:00:00Z',
+        type        => 'foo',
+    );
+
+    my $uri         = $dsfs->uri;
+    my $fileset     = $dsfs->fileset;
+    my $datatime    = $dsfs->datetime;
+    my $type        = $dsfs->type;
+    my DataStore::Response $response = $dsfs->request;
 
 =head1 DESCRIPTION
@@ -53 +64 @@
 
 =item * C<new()>
+
+Basic constructor.
+
+    my $dsfs = DateStore::FileSet->new(
+        uri         => 'http://example.org/',
+        fileset     => '12buckelyourshoe',
+        datetime    => '2042-01-01T00:00:00Z',
+        type        => 'foo',
+    );
+
+Accepts a mandatory hash and returns a L<DataStore::FileSet> object.
+
+=over 4
+
+=item * uri
+
+A valid I<HTTP> URI as a string.  I<A trailing slash is required.>
+
+=item * fileset
+
+The FileSet ID as a string.
+
+=item * datetime
+
+The time and date as a string.
+
+=item * type
+
+The I<type> of record as a string.
+
+=back
 
 =cut
@@ -91 +133 @@
 =over 4
 
+=item * C<uri()>
+
+Basic accessor.
+
+=item * C<fileset()>
+
+Basic accessor.
+
+=item * C<datetime()>
+
+Basic accessor.
+
+=item * C<type()>
+
+Basic accessor.
+
 =item * C<request()>
+
+Retrieves and processes the File listing pointed to by the L<uri> of this
+object.
+
+Accepts no parameters and returns a L<DataStore::Response> object.
 
 =cut
@@ -133 +196 @@
 }
 
+=back
+
+=head1 SEE ALSO
+
+L<DataStore::Response>
+
+=cut
+
 1;