com.ibm.as400.access

Class SubsystemEntryList

java.lang.Object

com.ibm.as400.access.SubsystemEntryList

public class SubsystemEntryList
extends java.lang.Object

Represents a list of subsystem entries.

Implementation note: This class internally calls the "List Subsystem Entries" API (QWDLSBSE). Information from formats SBSE0100 is retrieved.

See Also:

RoutingDataEntry

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTOSTART_JOB_ENTRY
static int	COMMUNICATION_ENTRY
static int	PRESTART_JOB_ENTRY
static int	REMOTE_LOCATION_ENTRY
static int	ROUTING_ENTRY
static int	WORKSTATION_NAME_ENTRY
static int	WORKSTATION_TYPE_ENTRY

Constructor Summary

Constructors

Constructor and Description
SubsystemEntryList(AS400 system, QSYSObjectPathName path) Constructs a SubsystemEntryList.
SubsystemEntryList(AS400 system, java.lang.String library, java.lang.String name) Constructs a SubsystemEntryList object.

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Removes all entries from this object.
RoutingDataEntry[]	getRoutingDataEntry() Returns an array of routing data entries.
RoutingDataEntry	getRoutingDataEntry(java.lang.String compareValue) Returns the routing data entry by compareValue.
void	load() Loads all entries from the specified subsystem.
void	refresh() Reloads all entries that have been specified.
void	setListType(int type)

Methods inherited from class java.lang.Object

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

Field Detail

ROUTING_ENTRY

public static final int ROUTING_ENTRY

See Also:

Constant Field Values

COMMUNICATION_ENTRY

public static final int COMMUNICATION_ENTRY

See Also:

Constant Field Values

REMOTE_LOCATION_ENTRY

public static final int REMOTE_LOCATION_ENTRY

See Also:

Constant Field Values

AUTOSTART_JOB_ENTRY

public static final int AUTOSTART_JOB_ENTRY

See Also:

Constant Field Values

PRESTART_JOB_ENTRY

public static final int PRESTART_JOB_ENTRY

See Also:

Constant Field Values

WORKSTATION_NAME_ENTRY

public static final int WORKSTATION_NAME_ENTRY

See Also:

Constant Field Values

WORKSTATION_TYPE_ENTRY

public static final int WORKSTATION_TYPE_ENTRY

See Also:

Constant Field Values

Constructor Detail

SubsystemEntryList

public SubsystemEntryList(AS400 system,
                  java.lang.String library,
                  java.lang.String name)

Constructs a SubsystemEntryList object.

Parameters:

system - The system where the subsystem resides.

library - The library containing the subsystem.

name - The subsystem name

SubsystemEntryList

public SubsystemEntryList(AS400 system,
                  QSYSObjectPathName path)

Constructs a SubsystemEntryList.

Parameters:

system - The system where the subsystem resides.

path - The fully qualified IFS path to the subsystem.

Method Detail

refresh

public void refresh()
             throws AS400SecurityException,
                    ErrorCompletingRequestException,
                    java.lang.InterruptedException,
                    java.io.IOException,
                    ObjectDoesNotExistException

Reloads all entries that have been specified.

Throws:

ObjectDoesNotExistException - If a system object necessary for the call does not exist on the system.

java.lang.InterruptedException - If this thread is interrupted.

java.io.IOException - If an error occurs while communicating with the system.

ErrorCompletingRequestException - If an error occurs before the request is completed.

AS400SecurityException - If a security or authority error occurs.

load

public void load()
          throws AS400Exception,
                 AS400SecurityException,
                 ErrorCompletingRequestException,
                 java.io.IOException,
                 java.lang.InterruptedException,
                 ObjectDoesNotExistException

Loads all entries from the specified subsystem.

Throws:

ObjectDoesNotExistException - If an object necessary for the call does not exist on the system.

java.lang.InterruptedException - If this thread is interrupted.

java.io.IOException - If an error occurs while communicating with the system.

ErrorCompletingRequestException - If an error occurs before the request is completed.

AS400SecurityException - If a security or authority error occurs.

AS400Exception - If the program on the server sends an escape message.

setListType

public void setListType(int type)

getRoutingDataEntry

public RoutingDataEntry getRoutingDataEntry(java.lang.String compareValue)

Returns the routing data entry by compareValue. If no entry null is returned.

Returns:

the routing data entry by compareValue

getRoutingDataEntry

public RoutingDataEntry[] getRoutingDataEntry()

Returns an array of routing data entries. If no entry could be retrieved because there are no entry or because of an error, an empty array is returned. If no entry has been retrieved yet due to no call to load(), then an empty array is returned.

Returns:

Array of retrieved member descriptions

clear

public void clear()

Removes all entries from this object.