com.ibm.eNetwork.HOD.customizable
Interface HODSession

All Known Subinterfaces:

HODDisplaySession, HODFTPSession, HODPrintSession

public interface HODSession

Field Summary

static int	FUNCTION_ALLOWED Return value indicating function is allowed.
static int	FUNCTION_DISABLED Return value indicating function is disabled by administrator
static int	FUNCTION_EXECUTED Return value indicating function call executed successfully
static int	FUNCTION_INVALID Return value indicating function call failed because it is invalid.
static int	FUNCTION_NOT_ALLOWED Return value indicating function call is not allowed at this time
static java.lang.String[]	STRING_RETURN_CODES

Method Summary

int	close() Closes the session and cleans up the resources.
int	connect() Triggers the session to connect to a host system.
int	disconnect() Triggers the session to disconnect from a host system.
javax.swing.JMenuBar	getHODMenubar() Gets the menu bar used by the session.
javax.swing.JPanel	getStatusBar() Gets the statusbar component used by the session.
boolean	isConnected() Returns whether the session is connected or not.
boolean	isStatusBarVisible() Returns true if the session is configured to start with status bar visible.
int	showProblemDetermination() Brings up the Problem Determination GUI.

Field Detail

FUNCTION_EXECUTED

public static final int FUNCTION_EXECUTED

Return value indicating function call executed successfully

See Also:

Constant Field Values

FUNCTION_DISABLED

public static final int FUNCTION_DISABLED

Return value indicating function is disabled by administrator

See Also:

Constant Field Values

FUNCTION_NOT_ALLOWED

public static final int FUNCTION_NOT_ALLOWED

Return value indicating function call is not allowed at this time

See Also:

Constant Field Values

FUNCTION_ALLOWED

public static final int FUNCTION_ALLOWED

Return value indicating function is allowed. Only used internally.

See Also:

Constant Field Values

FUNCTION_INVALID

public static final int FUNCTION_INVALID

Return value indicating function call failed because it is invalid.

See Also:

Constant Field Values

STRING_RETURN_CODES

public static final java.lang.String[] STRING_RETURN_CODES

Method Detail

getStatusBar

public javax.swing.JPanel getStatusBar()

Gets the statusbar component used by the session. It is a java.awt.Panel for the JDK 1.1 code.

getHODMenubar

public javax.swing.JMenuBar getHODMenubar()

Gets the menu bar used by the session. Use getSubElements() to obtain an array of the MenuElements to integrate these menu items into another Menu Bar. It is a java.awt.MenuBar for the JDK 1.1 code.

isConnected

public boolean isConnected()

Returns whether the session is connected or not.

connect

public int connect()

Triggers the session to connect to a host system.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

disconnect

public int disconnect()

Triggers the session to disconnect from a host system.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

showProblemDetermination

public int showProblemDetermination()

Brings up the Problem Determination GUI.

The return code indicates if the method was successful.

The possible values are

Constant	Description
HODSession.FUNCTION_EXECUTED	Function was successful
HODSession.FUNCTION_DISABLED	Function not allowed because it is disabled
HODSession.FUNCTION_NOT_ALLOWED	Function not allowed at this time

close

public int close()

Closes the session and cleans up the resources. The custom application must also clean up the session resources it is using.

isStatusBarVisible

public boolean isStatusBarVisible()

Returns true if the session is configured to start with status bar visible.

Returns:

true if the session is configured to start with status bar visible.