uk.ac.mrc.hgmp.embreo.filemgr
Class EmbreoFileRequest

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

public class EmbreoFileRequest
extends java.lang.Object


Constructor Summary
EmbreoFileRequest(EmbreoParams mysettings, java.lang.String method)
          A file request with no arguments.
EmbreoFileRequest(EmbreoParams mysettings, java.lang.String method, java.util.Vector args)
          A file request with arguments.
 
Method Summary
 java.util.Enumeration elements()
          The elements of the returned results hash
 java.lang.Object get(java.lang.Object key)
          Gets an element out of the embreo result hash
 java.lang.String getStatus()
          The status of the request
 java.lang.String getStatusMsg()
          A status message
 java.util.Hashtable hash()
          The returned results
 java.util.Enumeration keys()
          The keys of the returned results hash
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EmbreoFileRequest

public EmbreoFileRequest(EmbreoParams mysettings,
                         java.lang.String method)
                  throws EmbreoAuthException
A file request with no arguments. Calls EmbreoPrivateRequest with the service set to EmbreoFile.

Parameters:
mysettings - EmbreoParams defining server parameters
method - Which method to call on the server
Throws:
EmbreoAuthException - If authentication fails

EmbreoFileRequest

public EmbreoFileRequest(EmbreoParams mysettings,
                         java.lang.String method,
                         java.util.Vector args)
                  throws EmbreoAuthException
A file request with arguments. Calls EmbreoPrivateRequest with the service set to EmbreoFile.

Parameters:
mysettings - EmbreoParams defining server parameters
method - Which method to call on the server
args - A vector of arguments
Throws:
EmbreoAuthException - If authentication fails
Method Detail

getStatus

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

Returns:
String 0 for success Anything else for failure

getStatusMsg

public java.lang.String getStatusMsg()
A status message

Returns:
A String explaining what happened. Usually used to display an error message in the event of a failure

hash

public java.util.Hashtable hash()
The returned results

Returns:
A hashtable, often (but not always) containing a filename as the key

elements

public java.util.Enumeration elements()
The elements of the returned results hash


keys

public java.util.Enumeration keys()
The keys of the returned results hash


get

public java.lang.Object get(java.lang.Object key)
Gets an element out of the embreo result hash

Parameters:
key - The key to look up
Returns:
the element