ibm-information-center/dist/eclipse/plugins/i5OS.ic.rzahh_5.4.0.1/subsystemjavadoc.htm

1357 lines
79 KiB
HTML
Raw Permalink Normal View History

2024-04-02 14:02:31 +00:00
<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4.0//EN">
<HTML>
<HEAD>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2002, 2004 by IBM Corporation">
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<meta name="Owner" content="rchinfoc@us.ibm.com">
<meta scheme="rfc1766" name="DC.Language" content="en-us">
<meta scheme="iso8601" name="DC.Date" content="2004-04-01">
<meta name="Security" content="public">
<meta name="Source" content="">
<meta name="Robots" content="index,follow">
<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))'>
<meta name="keywords" content="com.ibm.as400.access.Subsystem,Subsystem class">
<title>Subsystem</title>
<link rel="stylesheet" type="text/css" href="javadoc/stylesheet.css" title="Style">
</head>
<SCRIPT LANGUAGE="Javascript" SRC="../rzahg/synch.js" TYPE="text/javascript"></SCRIPT>
<!-- ========== START OF NAVBAR ========== -->
<a name="navbar_top"><!-- --></a>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="javadoc/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="javadoc/com/ibm/as400/access/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="javadoc/com/ibm/as400/access/package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="javadoc/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="javadoc/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="javadoc/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</td>
<td rowspan="3" align="right" valign="top"><em>
</em>
</td>
</tr>
<tr>
<td class="NavBarCell2" bgcolor="white"><font size="-2">
&nbsp;<a href="javadoc/com/ibm/as400/access/SpooledFileOutputStream.html"><b>PREV CLASS</b></a>&nbsp;
&nbsp;<a href="javadoc/com/ibm/as400/access/package-summary.html"><b>NEXT CLASS</b></a></font></td>
<td class="NavBarCell2" bgcolor="white"><font size="-2">
<a href="javadoc/index.html" target="_top"><b>FRAMES</b></a> &nbsp;
&nbsp;<a href="subsystemjavadoc.htm" target="_top"><b>NO FRAMES</b></a> &nbsp;
&nbsp;
<noscript>
<A HREF="javadoc/allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</noscript>
</font></td>
</tr>
<tr>
<td class="NavBarCell3" valign="top"><font size="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<a href="#field_summary">FIELD</a>&nbsp;|&nbsp;<a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;<a href="#method_summary">METHOD</a></font></td>
<td class="NavBarCell3" valign="top"><font size="-2">
DETAIL:&nbsp;<a href="#field_detail">FIELD</a>&nbsp;|&nbsp;<a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;<a href="#method_detail">METHOD</a></font></td>
</tr>
</tbody></table>
<!-- =========== END OF NAVBAR =========== -->
<hr>
<!-- ======== START OF CLASS DATA ======== -->
<h2>
<font size="-1">
com.ibm.as400.access</font>
<br>
Class Subsystem</h2>
<pre><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html">java.lang.Object</a>
|
+--<b>com.ibm.as400.access.Subsystem</b>
</pre>
<hr>
<dl>
<dt>public class <b>Subsystem</b></dt><dt>extends <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html">Object</a></dt></dl>
<p>
Represents a subsystem on the server.
Most of the getter methods simply return the cached attribute value obtained by the most recent <a href="subsystemjavadoc.htm#refresh()"><code>refresh()</code></a>.
Other than getObjectDescription(), none of the getters will themselves
go to the system to get the current attribute value. Prior to the first
refresh(), many of the getters will return null or zero. <br>Example:
</p><pre>
Subsystem sbs = new Subsystem(system, library, name);
if (!sbs.exists()) {
System.out.println("No such subsystem: "+sbs.getPath());
}
else {
sbs.refresh();
System.out.println("Status: " + sbs.getStatus());
System.out.println("Number of jobs: " + sbs.getCurrentActiveJobs());
System.out.println("Maximum jobs: " + sbs.getMaximumActiveJobs());
SystemPool[] pools = sbs.getPools();
System.out.print("Pools: ");
if (pools == null) System.out.println("null");
else for (int i=0; i&lt;pools.length ;="" {="" system.out.print="" ="" +="" (pools[i="=" ?="" null="" :="" pools[i].getname="" }="" system.out.println="" all="" subsystems="" on="" +system.getsystemname="" subsystem="" list="Subsystem.listAllSubsystems(system);" for="" (int="" i=""&gt;&lt;list.length ;="" i="" {="" system.out.println(list[i].getlibrary="" +list[i].getname="" }="">&lt;/list.length&gt;&lt;/pools.length&gt;</pre>
<p>
</p><p>
</p><hr>
<p>
<!-- ======== NESTED CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<a name="field_summary"><!-- --></a>
<table border="1" cellpadding="3" cellspacing="0" width="100%">
<tbody><tr class="TableHeadingColor" bgcolor="#ccccff">
<td colspan="2"><font size="+2">
<b>Field Summary</b></font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>static&nbsp;int</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#NO_MAX">NO_MAX</a></b></code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value for the maximumActiveJobs property, indicating "no maximum".</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>static&nbsp;int</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm">NO_TIME_LIMIT</a></b></code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value for
the timeLimit parameter of the end() methods, indicating "no time
limit".</td>
</tr>
</tbody></table>
&nbsp;
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<a name="constructor_summary"><!-- --></a>
<table border="1" cellpadding="3" cellspacing="0" width="100%">
<tbody><tr class="TableHeadingColor" bgcolor="#ccccff">
<td colspan="2"><font size="+2">
<b>Constructor Summary</b></font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td><code><b><a href="subsystemjavadoc.htm#Subsystem(com.ibm.as400.access.AS400,java.lang.String)">Subsystem</a></b>(<a href="javadoc/com/ibm/as400/access/AS400.html">AS400</a>&nbsp;system,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;path)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a Subsystem object.
</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td><code><b><a href="subsystemjavadoc.htm#Subsystem(com.ibm.as400.access.AS400,java.lang.String,java.lang.String)">Subsystem</a></b>(<a href="javadoc/com/ibm/as400/access/AS400.html">AS400</a>&nbsp;system,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;library,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;name)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructs a Subsystem object.
</td>
</tr>
</tbody></table>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<a name="method_summary"><!-- --></a>
<table border="1" cellpadding="3" cellspacing="0" width="100%">
<tbody><tr class="TableHeadingColor" bgcolor="#ccccff">
<td colspan="2"><font size="+2">
<b>Method Summary</b></font></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#assignPool(int,int,int)">assignPool</a></b>(int&nbsp;sequenceNumber,
int&nbsp;size,
int&nbsp;activityLevel)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defines a
private storage pool and adds it to the list of storage pools defined
for the subsystem. </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#assignPool(int,java.lang.String)">assignPool</a></b>(int&nbsp;sequenceNumber,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;poolName)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Adds a
shared system pool to the list of storage pools defined for the
subsystem. </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#changeDescriptionText(java.lang.String)">changeDescriptionText</a></b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;text)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the subsystem description text. </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#changeDisplayFilePath(java.lang.String)">changeDisplayFilePath</a></b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;path)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies
the signon display file that is used when showing signon displays at
work stations allocated to the subsystem. </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#changeLanguageLibrary(java.lang.String)">changeLanguageLibrary</a></b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;library)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies a
library to enter ahead of other libraries in the system portion of the
library list. </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#changeMaximumActiveJobs(int)">changeMaximumActiveJobs</a></b>(int&nbsp;maxJobs)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the
maximum number of active jobs that can run or use resources within the
subsystem at one time.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#create()">create</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates the subsystem on the server.
</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#create(java.lang.String)">create</a></b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;authority)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates the subsystem on the server.
</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#delete()">delete</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the subsystem from the server.
</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#end(int)">end</a></b>(int&nbsp;timeLimit)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ends the subsystem on the server, in a controlled manner.
</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>static&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#endAllSubsystems(com.ibm.as400.access.AS400,int)">endAllSubsystems</a></b>(<a href="javadoc/com/ibm/as400/access/AS400.html">AS400</a>&nbsp;system,
int&nbsp;timeLimit)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ends all active subsystems on the server, in a controlled manner.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>static&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#endAllSubsystemsImmediately(com.ibm.as400.access.AS400)">endAllSubsystemsImmediately</a></b>(<a href="javadoc/com/ibm/as400/access/AS400.html">AS400</a>&nbsp;system)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ends all active subsystems on the server, immediately.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#endImmediately()">endImmediately</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ends the subsystem on the server, immediately.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;boolean</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#equals(java.lang.Object)">equals</a></b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html">Object</a>&nbsp;obj)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines whether this Subsystem object is equal to another object.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;boolean</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#exists()">exists</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if the subsystem currently exists on the system.
</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;int</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getCurrentActiveJobs()">getCurrentActiveJobs</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the number of jobs currently active in the subsystem.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a></code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getDescriptionText()">getDescriptionText</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the subsystem description text.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a></code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getDisplayFilePath()">getDisplayFilePath</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the
path of the signon display file that is used when showing signon
displays at work stations allocated to the subsystem. </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a></code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getLanguageLibrary()">getLanguageLibrary</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the
library that is entered ahead of other libraries in the system portion
of the library list. </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a></code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getLibrary()">getLibrary</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the
name of the library where the subsystem resides on the server.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;int</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getMaximumActiveJobs()">getMaximumActiveJobs</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the
maximum number of active jobs that can run or use resources within the
subsystem at one time.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;<a href="javadoc/com/ibm/as400/access/Job.html">Job</a></code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getMonitorJob()">getMonitorJob</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the subsystem monitor job.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a></code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getName()">getName</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the subsystem name.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;<a href="javadoc/com/ibm/as400/access/ObjectDescription.html">ObjectDescription</a></code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getObjectDescription()">getObjectDescription</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an ObjectDescription instance representing the subsystem.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a></code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getPath()">getPath</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the fully-qualifed IFS pathname of the subsystem.
</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;<a href="javadoc/com/ibm/as400/access/SystemPool.html">SystemPool</a></code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getPool(int)">getPool</a></b>(int&nbsp;sequenceNumber)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the
storage pool defined at the specified position for the subsystem.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;<a href="javadoc/com/ibm/as400/access/SystemPool.html">SystemPool</a>[]</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getPools()">getPools</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the
list of storage pools that are defined for the subsystem. </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a></code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getStatus()">getStatus</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the extended status of the subsystem.
</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;<a href="javadoc/com/ibm/as400/access/AS400.html">AS400</a></code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#getSystem()">getSystem</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the system where the subsystem resides.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>static&nbsp;<a href="subsystemjavadoc.htm">Subsystem</a>[]</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#listAllSubsystems(com.ibm.as400.access.AS400)">listAllSubsystems</a></b>(<a href="javadoc/com/ibm/as400/access/AS400.html">AS400</a>&nbsp;system)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Lists all subsystems on the system.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#refresh()">refresh</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Refreshes
the attributes of this Subsystem object, to reflect the current state
of the subsystem on the server.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#removePool(int)">removePool</a></b>(int&nbsp;sequenceNumber)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes a
storage pool from the list of pools defined for the subsystem. </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;void</code></font></td>
<td><code><b><a href="subsystemjavadoc.htm#start()">start</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Starts the subsystem on the server.</td>
</tr>
</tbody></table>
&nbsp;<a name="methods_inherited_from_class_java.lang.Object"><!-- --></a>
<table border="1" cellpadding="3" cellspacing="0" width="100%">
<tbody><tr class="TableSubHeadingColor" bgcolor="#eeeeff">
<td><b>Methods inherited from class java.lang.<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html">Object</a></b></td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#clone()">clone</a>, <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#finalize()">finalize</a>, <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#getClass()">getClass</a>, <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#hashCode()">hashCode</a>, <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notify()">notify</a>, <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#notifyAll()">notifyAll</a>, <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#toString()">toString</a>, <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait()">wait</a>, <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long)">wait</a>, <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#wait(long,int)">wait</a></code></td>
</tr>
</tbody></table>
&nbsp;
</p><p>
<!-- ============ FIELD DETAIL =========== -->
<a name="field_detail"><!-- --></a>
<table border="1" cellpadding="3" cellspacing="0" width="100%">
<tbody><tr class="TableHeadingColor" bgcolor="#ccccff">
<td colspan="1"><font size="+2">
<b>Field Detail</b></font></td>
</tr>
</tbody></table>
<a name="NO_MAX"><!-- --></a></p><h3>
NO_MAX</h3>
<pre>public static final int <b>NO_MAX</b></pre>
<dl>
<dd>Value for the maximumActiveJobs property, indicating "no maximum".
<p>
</p><dl>
<dt><b>See Also:</b></dt><dd><a href="javadoc/constant-values.html">Constant Field Values</a></dd></dl>
</dd></dl>
<hr>
<a name="NO_TIME_LIMIT"><!-- --></a><h3>
NO_TIME_LIMIT</h3>
<pre>public static final int <b>NO_TIME_LIMIT</b></pre>
<dl>
<dd>Value for the timeLimit parameter of the end() methods, indicating "no time limit".
<p>
</p><dl>
<dt><b>See Also:</b></dt><dd><a href="javadoc/constant-values.html">Constant Field Values</a></dd></dl>
</dd></dl>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<a name="constructor_detail"><!-- --></a>
<table border="1" cellpadding="3" cellspacing="0" width="100%">
<tbody><tr class="TableHeadingColor" bgcolor="#ccccff">
<td colspan="1"><font size="+2">
<b>Constructor Detail</b></font></td>
</tr>
</tbody></table>
<a name="Subsystem(com.ibm.as400.access.AS400, java.lang.String, java.lang.String)"><!-- --></a><h3>
Subsystem</h3>
<pre>public <b>Subsystem</b>(<a href="javadoc/com/ibm/as400/access/AS400.html">AS400</a>&nbsp;system,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;library,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;name)</pre>
<dl>
<dd>Constructs a Subsystem object.
<br>Note: Does not create a subsystem on the server.
<p>
</p></dd><dt><b>Parameters:</b></dt><dd><code>system</code> - The system.</dd><dd><code>library</code> - The name of the library where the subsystem resides.</dd><dd><code>name</code> - The simple name of the subsystem.</dd><dt><b>See Also:</b></dt><dd><a href="subsystemjavadoc.htm#create()"><code>create()</code></a></dd></dl>
<hr>
<a name="Subsystem(com.ibm.as400.access.AS400, java.lang.String)"><!-- --></a><h3>
Subsystem</h3>
<pre>public <b>Subsystem</b>(<a href="javadoc/com/ibm/as400/access/AS400.html">AS400</a>&nbsp;system,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;path)</pre>
<dl>
<dd>Constructs a Subsystem object.
<br>Note: Does not create a subsystem on the server.
<p>
</p></dd><dt><b>Parameters:</b></dt><dd><code>system</code> - The system.</dd><dd><code>path</code> - The qualified path. For example, "/QSYS.LIB/MYSUBSYS.SBSD".</dd><dt><b>See Also:</b></dt><dd><a href="subsystemjavadoc.htm#create()"><code>create()</code></a></dd></dl>
<!-- ============ METHOD DETAIL ========== -->
<a name="method_detail"><!-- --></a>
<table border="1" cellpadding="3" cellspacing="0" width="100%">
<tbody><tr class="TableHeadingColor" bgcolor="#ccccff">
<td colspan="1"><font size="+2">
<b>Method Detail</b></font></td>
</tr>
</tbody></table>
<a name="assignPool(int, java.lang.String)"><!-- --></a><h3>
assignPool</h3>
<pre>public void <b>assignPool</b>(int&nbsp;sequenceNumber,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;poolName)
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Adds a shared system pool to the list of storage pools defined for the subsystem.
Current pool definitions, other than the one specified, remain unchanged.
<p>
</p></dd><dd><dl>
<dt><b>Parameters:</b></dt><dd><code>sequenceNumber</code> - The number of the pool, within the pool list for the subsystem. Valid values are 1-10.</dd><dd><code>poolName</code>
- The name of a shared system storage pool. Valid values include:
*BASE, *NOSTG, *INTERACT, *SPOOL, and *SHRPOOLnn, where nn is an
integer from 1 to 60.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="assignPool(int, int, int)"><!-- --></a><h3>
assignPool</h3>
<pre>public void <b>assignPool</b>(int&nbsp;sequenceNumber,
int&nbsp;size,
int&nbsp;activityLevel)
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Defines a private storage pool and adds it to the list of storage pools defined for the subsystem.
Current pool definitions, other than the one specified, remain unchanged.
<p>
</p></dd><dd><dl>
<dt><b>Parameters:</b></dt><dd><code>sequenceNumber</code> - The number of the pool, within the pool list for the subsystem. Valid values are 1-10.</dd><dd><code>size</code> - The size of the storage pool, in kilobytes. Must be at least 256 (meaning 256 kilobytes).</dd><dd><code>activityLevel</code> - The activity level of the pool.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="changeDescriptionText(java.lang.String)"><!-- --></a><h3>
changeDescriptionText</h3>
<pre>public void <b>changeDescriptionText</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;text)
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Sets the subsystem description text. The default is "".
<p>
</p></dd><dd><dl>
<dt><b>Parameters:</b></dt><dd><code>text</code> - The subsystem description text. To clear the description, specify "".
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="changeDisplayFilePath(java.lang.String)"><!-- --></a><h3>
changeDisplayFilePath</h3>
<pre>public void <b>changeDisplayFilePath</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;path)
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Specifies the signon display file that is used when showing signon
displays at work stations allocated to the subsystem. By default,
QSYS/QDSIGNON (path /QSYS.LIB/QDSIGNON.FILE) is used.
<p>
</p></dd><dd><dl>
<dt><b>Parameters:</b></dt><dd><code>path</code> - The fully qualified pathname of the signon display file. See <a href="javadoc/com/ibm/as400/access/QSYSObjectPathName.html#toPath(java.lang.String,java.lang.String,java.lang.String)"><code>QSYSObjectPathName.toString()</code></a>
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="changeLanguageLibrary(java.lang.String)"><!-- --></a><h3>
changeLanguageLibrary</h3>
<pre>public void <b>changeLanguageLibrary</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;library)
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Specifies a library to enter ahead of other libraries in the system
portion of the library list. This method allows you to use a secondary
language library.
<p>
</p></dd><dd><dl>
<dt><b>Parameters:</b></dt><dd><code>library</code> - The name of the
library. Specify "" or "*NONE" to remove the current secondary language
library from the system library list.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="changeMaximumActiveJobs(int)"><!-- --></a><h3>
changeMaximumActiveJobs</h3>
<pre>public void <b>changeMaximumActiveJobs</b>(int&nbsp;maxJobs)
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Sets the maximum number of active jobs that can run or use resources within the subsystem at one time.
<p>
</p></dd><dd><dl>
<dt><b>Parameters:</b></dt><dd><code>maxJobs</code> - The maximum number of active jobs. Valid values are 0-1000. Special value <a href="subsystemjavadoc.htm#NO_MAX"><code>NO_MAX</code></a> is the default, and indicates no maximum.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="create()"><!-- --></a><h3>
create</h3>
<pre>public void <b>create</b>()
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectAlreadyExistsException.html">ObjectAlreadyExistsException</a></pre>
<dl>
<dd>Creates the subsystem on the server.
<br>More precisely, this method creates a subsystem <em>description</em> on the server.
<p>
</p></dd><dd><dl>
<dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectAlreadyExistsException.html">ObjectAlreadyExistsException</a></code> - If the object already exists on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="create(java.lang.String)"><!-- --></a><h3>
create</h3>
<pre>public void <b>create</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;authority)
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectAlreadyExistsException.html">ObjectAlreadyExistsException</a></pre>
<dl>
<dd>Creates the subsystem on the server.
<br>More precisely, this method creates a subsystem <em>description</em> on the server.
<p>
</p></dd><dd><dl>
<dt><b>Parameters:</b></dt><dd><code>authority</code> - The authority
to give to users who do not have specific authority for the object, who
are not on an authorization list, and whose group profile or
supplemental group profiles do not have specific authority for the
object. The default is *LIBCRTAUT. The "base system pool" (*BASE) is
used.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectAlreadyExistsException.html">ObjectAlreadyExistsException</a></code> - If the object already exists on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="delete()"><!-- --></a><h3>
delete</h3>
<pre>public void <b>delete</b>()
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></pre>
<dl>
<dd>Deletes the subsystem from the server.
<br>More precisely, this method deletes a subsystem <em>description</em> on the server.
<p>
</p></dd><dd><dl>
<dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="end(int)"><!-- --></a><h3>
end</h3>
<pre>public void <b>end</b>(int&nbsp;timeLimit)
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Ends the subsystem on the server, in a controlled manner. This
allows the programs that are running in the subsystem, to perform
cleanup (end of job processing). When a job being ended has a signal
handling procedure for the asynchronous signal SIGTERM, the SIGTERM
signal is generated for that job. The application has <tt>timeLimit</tt> seconds to complete cleanup before the job is ended.
<p>
</p></dd><dd><dl>
<dt><b>Parameters:</b></dt><dd><code>timeLimit</code> - The amount of
time (in seconds) that is allowed to complete the controlled subsystem
end operation. If this amount of time is exceeded and the end operation
is not complete, any jobs still being processed in the subsystem are
ended immediately. Special value <a href="subsystemjavadoc.htm#NO_TIME_LIMIT"><code>NO_TIME_LIMIT</code></a> indicates no time limit.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="endAllSubsystems(com.ibm.as400.access.AS400, int)"><!-- --></a><h3>
endAllSubsystems</h3>
<pre>public static void <b>endAllSubsystems</b>(<a href="javadoc/com/ibm/as400/access/AS400.html">AS400</a>&nbsp;system,
int&nbsp;timeLimit)
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></pre>
<dl>
<dd>Ends all active subsystems on the server, in a controlled manner.
<p>
</p></dd><dd><dl>
<dt><b>Parameters:</b></dt><dd><code>system</code> - The system.</dd><dd><code>timeLimit</code>
- The amount of time (in seconds) that is allowed to complete the
controlled subsystem end operation. If this amount of time is exceeded
and the end operation is not complete, any jobs still being processed
in the subsystem are ended immediately. Special value <a href="subsystemjavadoc.htm#NO_TIME_LIMIT"><code>NO_TIME_LIMIT</code></a> indicates no time limit.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="endAllSubsystemsImmediately(com.ibm.as400.access.AS400)"><!-- --></a><h3>
endAllSubsystemsImmediately</h3>
<pre>public static void <b>endAllSubsystemsImmediately</b>(<a href="javadoc/com/ibm/as400/access/AS400.html">AS400</a>&nbsp;system)
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></pre>
<dl>
<dd>Ends all active subsystems on the server, immediately.
<p>
</p></dd><dd><dl>
<dt><b>Parameters:</b></dt><dd><code>system</code> - The system.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="endImmediately()"><!-- --></a><h3>
endImmediately</h3>
<pre>public void <b>endImmediately</b>()
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Ends the subsystem on the server, immediately.
<p>
</p></dd><dd><dl>
<dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="equals(java.lang.Object)"><!-- --></a><h3>
equals</h3>
<pre>public boolean <b>equals</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html">Object</a>&nbsp;obj)</pre>
<dl>
<dd>Determines whether this Subsystem object is equal to another object.
<p>
</p></dd><dd><dl>
<dt><b>Overrides:</b></dt><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html#equals(java.lang.Object)">equals</a></code> in class <code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html">Object</a></code></dd></dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd><tt>true</tt> if the two instances are equal</dd></dl>
</dd>
</dl>
<hr>
<a name="exists()"><!-- --></a><h3>
exists</h3>
<pre>public boolean <b>exists</b>()
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Determines if the subsystem currently exists on the system.
<br>More precisely, this method reports if the subsystem <em>description</em> exists on the server.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>true if the subsystem exists; false if the subsystem does not exist.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the program call returns error messages.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the server API (that queries subsystem description information) is missing.</dd></dl>
</dd>
</dl>
<hr>
<a name="getCurrentActiveJobs()"><!-- --></a><h3>
getCurrentActiveJobs</h3>
<pre>public int <b>getCurrentActiveJobs</b>()</pre>
<dl>
<dd>Returns the number of jobs currently active in the subsystem.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>The number of currently active jobs. 0 if refresh() has not been called, or if the subsystem status is *INACTIVE.</dd></dl>
</dd>
</dl>
<hr>
<a name="getDescriptionText()"><!-- --></a><h3>
getDescriptionText</h3>
<pre>public <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a> <b>getDescriptionText</b>()</pre>
<dl>
<dd>Returns the subsystem description text.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>The subsystem description text. <tt>null</tt> if refresh() has not been called. "" if description is blank.</dd></dl>
</dd>
</dl>
<hr>
<a name="getDisplayFilePath()"><!-- --></a><h3>
getDisplayFilePath</h3>
<pre>public <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a> <b>getDisplayFilePath</b>()</pre>
<dl>
<dd>Returns the path of the signon display file that is used when
showing signon displays at work stations allocated to the subsystem. By
default, QSYS/QDSIGNON (path /QSYS.LIB/QDSIGNON.FILE) is used.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>The path of the signon display file. <tt>null</tt> if refresh() has not been called.</dd></dl>
</dd>
</dl>
<hr>
<a name="getLanguageLibrary()"><!-- --></a><h3>
getLanguageLibrary</h3>
<pre>public <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a> <b>getLanguageLibrary</b>()
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Returns the library that is entered ahead of other libraries in the
system portion of the library list. This library typically specifies a
secondary language library.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>The name of the secondary language library. <tt>null</tt> if refresh() has not been called. "*NONE" if no secondary language library is set.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="getLibrary()"><!-- --></a><h3>
getLibrary</h3>
<pre>public <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a> <b>getLibrary</b>()</pre>
<dl>
<dd>Returns the name of the library where the subsystem resides on the server.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>The name of the library.</dd></dl>
</dd>
</dl>
<hr>
<a name="getMaximumActiveJobs()"><!-- --></a><h3>
getMaximumActiveJobs</h3>
<pre>public int <b>getMaximumActiveJobs</b>()</pre>
<dl>
<dd>Returns the maximum number of active jobs that can run or use resources within the subsystem at one time.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>The maximum number of active jobs. 0 if refresh() has not been called. <a href="subsystemjavadoc.htm#NO_MAX"><code>NO_MAX</code></a> if no maximum.</dd></dl>
</dd>
</dl>
<hr>
<a name="getMonitorJob()"><!-- --></a><h3>
getMonitorJob</h3>
<pre>public <a href="javadoc/com/ibm/as400/access/Job.html">Job</a> <b>getMonitorJob</b>()</pre>
<dl>
<dd>Returns the subsystem monitor job.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>The subsystem monitor job. <tt>null</tt> if refresh() has not been called, or if subsystem status is *INACTIVE.</dd></dl>
</dd>
</dl>
<hr>
<a name="getName()"><!-- --></a><h3>
getName</h3>
<pre>public <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a> <b>getName</b>()</pre>
<dl>
<dd>Returns the subsystem name.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>The subsystem name.</dd></dl>
</dd>
</dl>
<hr>
<a name="getObjectDescription()"><!-- --></a><h3>
getObjectDescription</h3>
<pre>public <a href="javadoc/com/ibm/as400/access/ObjectDescription.html">ObjectDescription</a> <b>getObjectDescription</b>()</pre>
<dl>
<dd>Returns an ObjectDescription instance representing the subsystem.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>An ObjectDescription for the subsystem.</dd></dl>
</dd>
</dl>
<hr>
<a name="getPath()"><!-- --></a><h3>
getPath</h3>
<pre>public <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a> <b>getPath</b>()</pre>
<dl>
<dd>Returns the fully-qualifed IFS pathname of the subsystem.
For example: "/QSYS.LIB/MYSUBSYS.SBSD".
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>The path of the subsystem.</dd></dl>
</dd>
</dl>
<hr>
<a name="getPool(int)"><!-- --></a><h3>
getPool</h3>
<pre>public <a href="javadoc/com/ibm/as400/access/SystemPool.html">SystemPool</a> <b>getPool</b>(int&nbsp;sequenceNumber)</pre>
<dl>
<dd>Returns the storage pool defined at the specified position for the subsystem.
<p>
</p></dd><dd><dl>
<dt><b>Parameters:</b></dt><dd><code>sequenceNumber</code> - The number of the pool, within the pool list for the subsystem. Valid values are 1-10.
</dd><dt><b>Returns:</b></dt><dd>The pool used by the subsystem, at the specified sequence position. <tt>null</tt> if refresh() has not been called, or if no pool has been assigned at that position.</dd></dl>
</dd>
</dl>
<hr>
<a name="getPools()"><!-- --></a><h3>
getPools</h3>
<pre>public <a href="javadoc/com/ibm/as400/access/SystemPool.html">SystemPool</a>[] <b>getPools</b>()</pre>
<dl>
<dd>Returns the list of storage pools that are defined for the
subsystem. That is, the list of storage pool definitions that are in
the subsystem description. The element at offset 0 represents subsystem
pool #1, element at offset 1 represents pool #2, and so on. In
positions where no pool assignment has been made, the array element
will be null.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>The pools that are used by the subsystem. <tt>null</tt> if refresh() has not been called. Otherwise, a 10-element array is returned.</dd></dl>
</dd>
</dl>
<hr>
<a name="getStatus()"><!-- --></a><h3>
getStatus</h3>
<pre>public <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a> <b>getStatus</b>()</pre>
<dl>
<dd>Returns the extended status of the subsystem.
Possible values are: *ACTIVE, *ENDING, *INACTIVE, *RESTRICTED, and *STARTING.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>The subsystem status. <tt>null</tt> if refresh() has not been called.</dd></dl>
</dd>
</dl>
<hr>
<a name="getSystem()"><!-- --></a><h3>
getSystem</h3>
<pre>public <a href="javadoc/com/ibm/as400/access/AS400.html">AS400</a> <b>getSystem</b>()</pre>
<dl>
<dd>Returns the system where the subsystem resides.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>The system.</dd></dl>
</dd>
</dl>
<hr>
<a name="listAllSubsystems(com.ibm.as400.access.AS400)"><!-- --></a><h3>
listAllSubsystems</h3>
<pre>public static <a href="subsystemjavadoc.htm">Subsystem</a>[] <b>listAllSubsystems</b>(<a href="javadoc/com/ibm/as400/access/AS400.html">AS400</a>&nbsp;system)
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a>,
<a href="javadoc/com/ibm/as400/access/RequestNotSupportedException.html">RequestNotSupportedException</a></pre>
<dl>
<dd>Lists all subsystems on the system.
<p>
</p></dd><dd><dl>
<dt><b>Returns:</b></dt><dd>A list of all defined subsystems, both active and inactive.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/RequestNotSupportedException.html">RequestNotSupportedException</a></code> - If the requested function is not supported because the server is not at the correct level.</dd></dl>
</dd>
</dl>
<hr>
<a name="refresh()"><!-- --></a><h3>
refresh</h3>
<pre>public void <b>refresh</b>()
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Refreshes the attributes of this Subsystem object, to reflect the current state of the subsystem on the server.
<p>
</p></dd><dd><dl>
<dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="removePool(int)"><!-- --></a><h3>
removePool</h3>
<pre>public void <b>removePool</b>(int&nbsp;sequenceNumber)
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Removes a storage pool from the list of pools defined for the subsystem.
You should first end the subsystem before removing a pool.
<p>
</p></dd><dd><dl>
<dt><b>Parameters:</b></dt><dd><code>sequenceNumber</code> - The number of the pool, within the pool list for the subsystem. Valid values are 1-10.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="start()"><!-- --></a><h3>
start</h3>
<pre>public void <b>start</b>()
throws <a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a>,
<a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a>,
<a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Starts the subsystem on the server.
<p>
</p></dd><dd><dl>
<dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the server returns an error message.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/AS400SecurityException.html">AS400SecurityException</a></code> - If a security or authority error occurs.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ErrorCompletingRequestException.html">ErrorCompletingRequestException</a></code> - If an error occurs before the request is completed.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></code> - If this thread is interrupted.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/IOException.html">IOException</a></code> - If an error occurs while communicating with the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the object does not exist on the server.</dd></dl>
</dd>
</dl>
<!-- ========= END OF CLASS DATA ========= -->
<hr>
<!-- ========== START OF NAVBAR ========== -->
<a name="navbar_bottom"><!-- --></a>
<table border="0" cellpadding="1" cellspacing="0" width="100%">
<tbody><tr>
<td colspan="3" class="NavBarCell1" bgcolor="#eeeeff">
<a name="navbar_bottom_firstrow"><!-- --></a>
<table border="0" cellpadding="0" cellspacing="3">
<tbody><tr align="center" valign="top">
<td class="NavBarCell1" bgcolor="#eeeeff"> <a href="javadoc/overview-summary.html"><font class="NavBarFont1"><b>Overview</b></font></a>&nbsp;</td>
<td class="NavBarCell1" bgcolor="#eeeeff"> <a href="javadoc/com/ibm/as400/access/package-summary.html"><font class="NavBarFont1"><b>Package</b></font></a>&nbsp;</td>
<td class="NavBarCell1Rev" bgcolor="#ffffff"> &nbsp;<font class="NavBarFont1Rev"><b>Class</b></font>&nbsp;</td>
<td class="NavBarCell1" bgcolor="#eeeeff"> <a href="javadoc/com/ibm/as400/access/package-tree.html"><font class="NavBarFont1"><b>Tree</b></font></a>&nbsp;</td>
<td class="NavBarCell1" bgcolor="#eeeeff"> <a href="javadoc/deprecated-list.html"><font class="NavBarFont1"><b>Deprecated</b></font></a>&nbsp;</td>
<td class="NavBarCell1" bgcolor="#eeeeff"> <a href="javadoc/index-all.html"><font class="NavBarFont1"><b>Index</b></font></a>&nbsp;</td>
<td class="NavBarCell1" bgcolor="#eeeeff"> <a href="javadoc/help-doc.html"><font class="NavBarFont1"><b>Help</b></font></a>&nbsp;</td>
</tr>
</tbody></table>
</td>
<td rowspan="3" align="right" valign="top"><em>
</em>
</td>
</tr>
<tr>
<td class="NavBarCell2" bgcolor="white"><font size="-2">
&nbsp;<a href="javadoc/com/ibm/as400/access/SpooledFileOutputStream.html"><b>PREV CLASS</b></a>&nbsp;
&nbsp;<a href="javadoc/com/ibm/as400/access/package-summary.html"><b>NEXT CLASS</b></a></font></td>
<td class="NavBarCell2" bgcolor="white"><font size="-2">
<a href="javadoc/index.html" target="_top"><b>FRAMES</b></a> &nbsp;
&nbsp;<a href="subsystemjavadoc.htm" target="_top"><b>NO FRAMES</b></a> &nbsp;
&nbsp;
<noscript>
<A HREF="javadoc/allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
</noscript>
</font></td>
</tr>
<tr>
<td class="NavBarCell3" valign="top"><font size="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<a href="#field_summary">FIELD</a>&nbsp;|&nbsp;<a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;<a href="#method_summary">METHOD</a></font></td>
<td class="NavBarCell3" valign="top"><font size="-2">
DETAIL:&nbsp;<a href="#field_detail">FIELD</a>&nbsp;|&nbsp;<a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;<a href="#method_detail">METHOD</a></font></td>
</tr>
</tbody></table>
<!-- =========== END OF NAVBAR =========== -->
<hr>
</body></html>