com.phoenix_int.aserver
Interface IPHXComponent

All Known Subinterfaces:

IPHXAnalysis, IPHXDriver

public interface IPHXComponent

this is a common base interface for things served on the Analysis Server. In addition to the functions specified by this interface, the following static functions may also be defined to provide additional information about a component.

• public static String getVersion() retrieves the version of the component.
• public static String getAuthor() retrieves the author of the component.
• public static String getDescription() retrieves a one- line description of the component.
• public static String getHelpURL() retrieves a URL associated with the component.
• public static String getKeywords() retrieves keywords associated with the component.
• public static String getIconFile() retrieves the name of a 64x64 bmp file used to represent the component as an icon in graphical environments.

The above functions are used by the "describe" command in the Analysis Server. If not defined, default values are used. The functions are all static so that they may be called without instantiating the component.

Method Summary

void	end() notifies the driver that it has ended.

Method Detail

end

void end()
         throws java.lang.Exception

notifies the driver that it has ended. The driver should perform any necesary shutdown functions.

Throws:

java.lang.Exception - thrown if the function does not complete succesfully