[MOBY-guts] biomoby commit

[Mark Wilkinson]

mwilkinson
Thu Feb  8 13:50:24 EST 2007
Update of /home/repository/moby/moby-live/Perl/MOBY/Client
In directory dev.open-bio.org:/tmp/cvs-serv28032/MOBY/Client

Modified Files:
	Service.pm ServiceInstance.pm 
Log Message:
fixing documentation
moby-live/Perl/MOBY/Client Service.pm,1.32,1.33 ServiceInstance.pm,1.18,1.19
===================================================================
RCS file: /home/repository/moby/moby-live/Perl/MOBY/Client/Service.pm,v
retrieving revision 1.32
retrieving revision 1.33
diff -u -r1.32 -r1.33
--- /home/repository/moby/moby-live/Perl/MOBY/Client/Service.pm	2007/02/06 21:46:12	1.32
+++ /home/repository/moby/moby-live/Perl/MOBY/Client/Service.pm	2007/02/08 18:50:24	1.33
@@ -166,11 +166,12 @@
 
 To have the service iterate over multiple equivalent objects, and
 return all the results in a single message, use this syntax (ARGS =
-([...], [...], ...):
+([...], [...], ...).  Here, the articleName of the input parameter is
+"input1":
 
   $Service->execute(XMLinputlist => [ 
-                        ['object1', '<Object namespace="blah" id="123"/>'],
-                        ['object2', '<Object namespace="blah" id="234"/>']
+                        ['input1', '<Object namespace="blah" id="123"/>'],
+                        ['input1', '<Object namespace="blah" id="234"/>']
                             ]);
 
 This would invoke the service twice (in a single message) the first
@@ -178,10 +179,11 @@
 
 =item Process a Collection
 
-To pass in a Collection, you need this syntax (ARGS = [ '', [..., ..., ...] ]):
+To pass in a Collection, you need this syntax (ARGS = [ '', [..., ..., ...] ]).
+Here, the articleName of the input is "input1".
 
   $Service->execute(XMLinputlist => [
-                 ['', [
+                 ['input1', [
                      '<Object namespace="blah" id="123"/>',
                      '<Object namespace="blah" id="234"/>']
               ]);
@@ -191,7 +193,9 @@
 
 =item Process multiple Simple inputs
 
-To pass in multiple inputs, to be considered neither a Collection nor sequentially evaluated, use this syntax (ARGS = [..., ..., ...])
+To pass in multiple inputs, to be considered neither a Collection nor sequentially
+evaluated, use this syntax (ARGS = [..., ..., ...]).  Here, the service consumes
+two inputs with articleName input1 and input2
 
   $Service->execute(XMLinputlist => [
             [
@@ -200,8 +204,7 @@
             ]
 		     ]);
 
-This would cause a single invocation of a service requiring two input
-parameters named "input1" and "input2"
+This would cause a single invocation of a service.
 
 =item Parameters
 

===================================================================
RCS file: /home/repository/moby/moby-live/Perl/MOBY/Client/ServiceInstance.pm,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- /home/repository/moby/moby-live/Perl/MOBY/Client/ServiceInstance.pm	2006/08/10 23:05:18	1.18
+++ /home/repository/moby/moby-live/Perl/MOBY/Client/ServiceInstance.pm	2007/02/08 18:50:24	1.19
@@ -98,6 +98,17 @@
 
 =cut
 
+=head2 category
+
+ Title     :	category
+ Usage     :	$category = $Service->category($arg)
+ Args      :    (optional) scalar string with moby service category ['moby' | 'post' | 'moby-async']
+ Function  :	get/set category
+ Returns   :	string
+
+=cut
+
+
 =head2 input
 
  Title     :	input