com.ibm.eNetwork.HOD.customizable
Class CustomDesktop

java.lang.Object
  |
  +--com.ibm.eNetwork.HOD.customizable.BaseDesktop
        |
        +--com.ibm.eNetwork.HOD.customizable.CustomDesktop

public class CustomDesktop

extends BaseDesktop

Field Summary

static java.lang.String	SESSION_TYPE_3270_PRT_STR 3270 printer session type
static java.lang.String	SESSION_TYPE_3270_STR 3270 display session type
static java.lang.String	SESSION_TYPE_5250_PRT_STR 5250 printer session type
static java.lang.String	SESSION_TYPE_5250_STR 5250 display session type
static java.lang.String	SESSION_TYPE_CICS_STR CICS display session type
static java.lang.String	SESSION_TYPE_FTP_STR FTP session type
static java.lang.String	SESSION_TYPE_VT_STR VT display session type

Method Summary

int	copySession(java.lang.String sessionName) Creates a copy of the session specified.
int	deleteSession(java.lang.String sessionName) Deletes the session specified.
int	exportSession(java.lang.String sessionName) Calls code to Export the session specified.
java.lang.String[]	getSessionNames() Method called to return a list of the session names defined.
java.lang.String	getSessionType(java.lang.String sessionName) Method called to determine the type of session.
boolean	isAutoStartSession(java.lang.String sessionName) Returns true if the session is configured to start automatically.
int	renameSession(java.lang.String sessionName, java.lang.String newSessionName) Renames a session name to a new name.
int	showConfigDialog(java.lang.String sessionName) Opens a modal dialog that shows the session properties of a session.
HODDisplaySession	startDisplaySession(java.lang.String sessionName) Method called to start a particular Host On-Demand session.
HODFTPSession	startFTPSession(java.lang.String sessionName) Method called to start a particular Host On-Demand sessions.
HODPrintSession	startPrintSession(java.lang.String sessionName) Method called to start a particular Host On-Demand session.

Methods inherited from class com.ibm.eNetwork.HOD.customizable.BaseDesktop

closeAllSessions, save

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SESSION_TYPE_3270_STR

public static final java.lang.String SESSION_TYPE_3270_STR

3270 display session type

See Also:

Constant Field Values

SESSION_TYPE_5250_STR

public static final java.lang.String SESSION_TYPE_5250_STR

5250 display session type

See Also:

Constant Field Values

SESSION_TYPE_VT_STR

public static final java.lang.String SESSION_TYPE_VT_STR

VT display session type

See Also:

Constant Field Values

SESSION_TYPE_CICS_STR

public static final java.lang.String SESSION_TYPE_CICS_STR

CICS display session type

See Also:

Constant Field Values

SESSION_TYPE_3270_PRT_STR

public static final java.lang.String SESSION_TYPE_3270_PRT_STR

3270 printer session type

See Also:

Constant Field Values

SESSION_TYPE_5250_PRT_STR

public static final java.lang.String SESSION_TYPE_5250_PRT_STR

5250 printer session type

See Also:

Constant Field Values

SESSION_TYPE_FTP_STR

public static final java.lang.String SESSION_TYPE_FTP_STR

FTP session type

See Also:

Constant Field Values

Method Detail

showConfigDialog

public int showConfigDialog(java.lang.String sessionName)

Opens a modal dialog that shows the session properties of a session. Changes will be saved when the properties are closed. 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
HODSession.FUNCTION_INVALID	Function invalid because specified session was not found

Parameters:

sessionName - Name of the session to configure

copySession

public int copySession(java.lang.String sessionName)

Creates a copy of the session specified. The name of the new session will be the next unique number, then a ":", and then the name of the current session. 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
HODSession.FUNCTION_INVALID	Function invalid because specified session was not found

Parameters:

sessionName - Name of the session to copy

deleteSession

public int deleteSession(java.lang.String sessionName)

Deletes the session specified. 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
HODSession.FUNCTION_INVALID	Function invalid because specified session was not found

Parameters:

sessionName - Name of the session to delete

exportSession

public int exportSession(java.lang.String sessionName)

Calls code to Export the session specified. 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
HODSession.FUNCTION_INVALID	Function invalid because specified session was not found

Parameters:

sessionName - Name of the session to delete

renameSession

public int renameSession(java.lang.String sessionName,
                         java.lang.String newSessionName)

Renames a session name to a new name. The new name must be a name that currently does not already exist. 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
HODSession.FUNCTION_INVALID	Function invalid because specified session was not found

Parameters:

sessionName - Name of the session to configure

newSessionName - new name of the session property

startDisplaySession

public HODDisplaySession startDisplaySession(java.lang.String sessionName)
                                      throws HODSessionException

Method called to start a particular Host On-Demand session. An exception will be thrown if a session by this name could not be started.

Parameters:

sessionName - Name of the session to start

Throws:

HODSessionException - Thrown if a display session with this name could not be started

getSessionNames

public java.lang.String[] getSessionNames()

Method called to return a list of the session names defined.

startPrintSession

public HODPrintSession startPrintSession(java.lang.String sessionName)
                                  throws HODSessionException

Method called to start a particular Host On-Demand session. An exception will be thrown if a session by this name could not be started.

Parameters:

sessionName - Name of the session to start

Throws:

HODSessionException - Thrown if a printer session with this name could not be started

startFTPSession

public HODFTPSession startFTPSession(java.lang.String sessionName)
                              throws HODSessionException

Method called to start a particular Host On-Demand sessions. An exception will be thrown if a session by this name could not be started.

Parameters:

sessionName - Name of the session to start

Throws:

HODSessionException - Thrown if an FTP session with this name could not be started

getSessionType

public java.lang.String getSessionType(java.lang.String sessionName)

Method called to determine the type of session. Returns null if the type could be determined.

Parameters:

sessionName - Name of the session to check Returns the string representing session type

The possible values are

Constant	Description
CustomDesktop.SESSION_TYPE_3270_STR	3270 display session
CustomDesktop.SESSION_TYPE_5250_STR	5250 display session
CustomDesktop.SESSION_TYPE_VT_STR	VT display session
CustomDesktop.SESSION_TYPE_CICS_STR	CICS display session
CustomDesktop.SESSION_TYPE_FTP_STR	FTP session
CustomDesktop.SESSION_TYPE_3270_PTR_STR	3270 host print session
CustomDesktop.SESSION_TYPE_5250_PTR_STR	5250 host print session

isAutoStartSession

public boolean isAutoStartSession(java.lang.String sessionName)

Returns true if the session is configured to start automatically.

Parameters:

sessionName - Name of the session to check

Returns:

true if the session is configured to start automatically