uk.ac.mrc.hgmp.embreo
Class EmbreoHelp
java.lang.Object
|
+--uk.ac.mrc.hgmp.embreo.EmbreoHelp
- public class EmbreoHelp
- extends java.lang.Object
Constructor Summary |
EmbreoHelp(java.lang.String acdProg,
EmbreoParams mysettings)
Get the help text for an application |
Method Summary |
java.lang.String |
getFormat()
The format of the help text |
java.lang.String |
getHelpText()
The help text returned |
java.lang.String |
getStatus()
The status of the request |
java.lang.String |
getStatusMsg()
A status message |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
EmbreoHelp
public EmbreoHelp(java.lang.String acdProg,
EmbreoParams mysettings)
- Get the help text for an application
- Parameters:
acdProg
- The name of the application to get the help text formysettings
- EmbreoParams defining server parameters
getStatus
public java.lang.String getStatus()
- The status of the request
- Returns:
- String 0 for success, anything else for failure. Failure
may be interpreted as indicating that showdb is meaningless for
an application.
getStatusMsg
public java.lang.String getStatusMsg()
- A status message
- Returns:
- A string containing a status message. In the case of an error,
contains a description of the error.
getHelpText
public java.lang.String getHelpText()
- The help text returned
getFormat
public java.lang.String getFormat()
- The format of the help text