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

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.
java.lang.String[]	getSessionNames() Method called to return a list of the session names defined.
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

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

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