planetj.common
Interface IAS400ProgramCall

public interface IAS400ProgramCall

This type was created in VisualAge.

Method Summary

void	connect(com.ibm.as400.access.AS400 obj) Connect to the AS/400 using the specified AS/400 Toolbox object.
void	disconnectFrom400() Disconnect from current AS/400 connection.
String	getCompletionMsg() Get the completion message after the program has run.
com.ibm.as400.access.AS400Message[]	getMessageList() Get the array of AS400Message objects
boolean	isConnected() Returns the state of the connection to the AS/400.
boolean	runProgram() Run the AS/400 program RDNSETLIBL.
void	setAS400(com.ibm.as400.access.AS400 system) Set the AS400 to used for this program call.

Method Detail

connect

public void connect(com.ibm.as400.access.AS400 obj)
             throws com.ibm.as400.access.AS400SecurityException,
                    IOException,
                    com.ibm.as400.access.ServerStartupException,
                    UnknownHostException,
                    IllegalArgumentException

Connect to the AS/400 using the specified AS/400 Toolbox object.

Throws:

com.ibm.as400.access.AS400SecurityException - If security error occurs during connect.

IOException - If IO error occurs during connect.

com.ibm.as400.access.ServerStartupException - If unable to connect to the well known port.

UnknownHostException - If unable to locate AS/400.

IllegalArgumentException - If service is incorrect.

disconnectFrom400

public void disconnectFrom400()

Disconnect from current AS/400 connection.

getCompletionMsg

public String getCompletionMsg()

Get the completion message after the program has run.

Returns:

A string with a generic pass or fail message.

getMessageList

public com.ibm.as400.access.AS400Message[] getMessageList()

Get the array of AS400Message objects

Returns:

A string with a generic pass or fail message.

isConnected

public boolean isConnected()

Returns the state of the connection to the AS/400.

Returns:

true if connected, false if not connected.

runProgram

public boolean runProgram()
                   throws com.ibm.as400.access.AS400SecurityException,
                          com.ibm.as400.access.ConnectionDroppedException,
                          com.ibm.as400.access.ErrorCompletingRequestException,
                          InterruptedException,
                          IOException,
                          PropertyVetoException,
                          com.ibm.as400.access.ObjectDoesNotExistException

Run the AS/400 program RDNSETLIBL.

Returns:

true if successful, false if problems occurred.

Throws:

com.ibm.as400.access.AS400SecurityException - If security violation occurs during connection.

com.ibm.as400.access.ConnectionDroppedException - If the AS/400 connection is inactive.

com.ibm.as400.access.ErrorCompletingRequestException - If an error occurred on the host

InterruptedException - If this thread is interrupted.

IOException - If an I/O error occurs.

PropertyVetoException - If program or parameter list is set to an invalid value.

com.ibm.as400.access.ObjectDoesNotExistException - If program does not exist.

setAS400

public void setAS400(com.ibm.as400.access.AS400 system)

Set the AS400 to used for this program call. The AS400 contains the connection to the AS/400.