uk.ac.mrc.hgmp.embreo
Class EmbreoAppList

java.lang.Object
  |
  +--uk.ac.mrc.hgmp.embreo.EmbreoAppList

public class EmbreoAppList
extends java.lang.Object


Constructor Summary
EmbreoAppList(java.lang.String listType, EmbreoParams mysettings)
          Retrieve the list of available applications from an Embreo Server
 
Method Summary
 java.util.Enumeration elements()
          Gives the returned elements of the embreo request
 java.lang.Object get(java.lang.Object key)
          Extract an element of the embreo results hash
 java.util.Hashtable getHash()
          Gives the hash returned by the embreo request, in raw form
 int getNumProgs()
          How many programs are available
 java.lang.String[] getProgDescription()
          The program descriptions as a String array
 java.lang.String[] getProgsList()
          The available programs as a String array
 java.lang.String getStatus()
          The success of the request
 java.lang.String getStatusMsg()
          A status message from the server.
 java.util.Enumeration keys()
          Gives the returned keys of the embreo request
 boolean succeeded()
          Whether the underlying soap call worked
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EmbreoAppList

public EmbreoAppList(java.lang.String listType,
                     EmbreoParams mysettings)
Retrieve the list of available applications from an Embreo Server

Parameters:
listType - The format we want the list in Basic format is a simple list Extended format is a hash of app/description
mysettings - EmbreoParams defining server parameters
Method Detail

getNumProgs

public int getNumProgs()
How many programs are available


getProgsList

public java.lang.String[] getProgsList()
The available programs as a String array


getProgDescription

public java.lang.String[] getProgDescription()
The program descriptions as a String array


succeeded

public boolean succeeded()
Whether the underlying soap call worked


getStatus

public java.lang.String getStatus()
The success of the request

Returns:
String 0 for success, anything else for failure

getStatusMsg

public java.lang.String getStatusMsg()
A status message from the server. In the case of an error, explains why the error occurred


elements

public java.util.Enumeration elements()
Gives the returned elements of the embreo request


keys

public java.util.Enumeration keys()
Gives the returned keys of the embreo request


get

public java.lang.Object get(java.lang.Object key)
Extract an element of the embreo results hash


getHash

public java.util.Hashtable getHash()
Gives the hash returned by the embreo request, in raw form