cfa.vo.iris
Interface IrisApplication

All Known Implementing Classes:

AbstractIrisApplication

public interface IrisApplication

This interface must implemented by enclosing application. An instance of this interface is provided to the components when they are initialized, so that they can access application-wide information and operations.

Author:

olaurino

Method Summary

File	getConfigurationDir() Get a pointer to the directory that contains all the configuration files for this component.
URL	getHelpURL()
cfa.vo.interop.SAMPController	getSAMPController()
boolean	isSampEnabled() Return whether or not SAMP was enabled for this session.
void	sendSampMessage(org.astrogrid.samp.Message msg)
void	sendSedMessage(ExtSed sed) Convenience shortcut that allows components to broadcast a SED message to the SAMP hub.

Method Detail

getConfigurationDir

File getConfigurationDir()

Get a pointer to the directory that contains all the configuration files for this component.

Returns:

A File instance for the configuration directory.

isSampEnabled

boolean isSampEnabled()

Return whether or not SAMP was enabled for this session. SAMP features could be required to be switched on and off when the application is launched.

Returns:

True if SAMP is enabled in this session.

sendSedMessage

void sendSedMessage(ExtSed sed)
                    throws org.astrogrid.samp.client.SampException

Convenience shortcut that allows components to broadcast a SED message to the SAMP hub.

Parameters:

sed - The SED file that has to be sent through SAMP

sedId - The ID of the SED file sent

Throws:

org.astrogrid.samp.client.SampException - If an exception is thrown while the message is being sent

sendSampMessage

void sendSampMessage(org.astrogrid.samp.Message msg)
                     throws org.astrogrid.samp.client.SampException

Throws:

org.astrogrid.samp.client.SampException

getSAMPController

cfa.vo.interop.SAMPController getSAMPController()

getHelpURL

URL getHelpURL()