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

1844 lines
108 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.SaveFile,SaveFile class">
<title>SaveFile</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/RootPermission.html"><b>PREV CLASS</b></a>&nbsp;
&nbsp;<a href="javadoc/com/ibm/as400/access/SCS3812Writer.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="savefilejavadoc.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 SaveFile</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.SaveFile</b>
</pre>
<dl>
<dt><b>All Implemented Interfaces:</b> </dt><dd><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Serializable.html">Serializable</a></dd>
</dl>
<hr>
<dl>
<dt>public class <b>SaveFile</b></dt><dt>extends <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/Object.html">Object</a></dt><dt>implements <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/Serializable.html">Serializable</a></dt></dl>
<p>
Represents a save file on a server.
</p><p>
</p><p>
</p><dl>
<dt><b>See Also:</b></dt><dd><a href="javadoc/serialized-form.html">Serialized Form</a></dd></dl>
<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="savefilejavadoc.htm#CLS">CLS</a></b></code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Special value for the "waitTime" property. </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>static&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="savefilejavadoc.htm#CURRENT_RELEASE">CURRENT_RELEASE</a></b></code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value for
the "targetRelease" property, indicating "current release". </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="savefilejavadoc.htm#DEFAULT">DEFAULT</a></b></code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Special
value for the "maximumNumberOfRecords", "waitTime", and "asp"
properties. </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="savefilejavadoc.htm#IMMED">IMMED</a></b></code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value for the "waitTime" property, indicating "immediate". </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>static&nbsp;long</code></font></td>
<td><code><b><a href="savefilejavadoc.htm#NO_MAX">NO_MAX</a></b></code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value for
the "maximumNumberOfRecords" property, indicating that the system
maximum is used.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>static&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="savefilejavadoc.htm#PREVIOUS_RELEASE">PREVIOUS_RELEASE</a></b></code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Value for
the "targetRelease" property, indicating "previous release". </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="savefilejavadoc.htm#SaveFile(com.ibm.as400.access.AS400,java.lang.String,java.lang.String)">SaveFile</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 SaveFile 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="savefilejavadoc.htm#clear()">clear</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Clears all
existing records from the save file and reduces the amount of storage
used by this file. </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="savefilejavadoc.htm#copyTo(java.lang.String,java.lang.String)">copyTo</a></b>(<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;Copies the save file to another save file on the same 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="savefilejavadoc.htm#create()">create</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a save file 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="savefilejavadoc.htm#create(long,int,int,boolean,java.lang.String,java.lang.String)">create</a></b>(long&nbsp;maxRecords,
int&nbsp;asp,
int&nbsp;waitTime,
boolean&nbsp;shared,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;authority,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;description)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a save file 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="savefilejavadoc.htm#delete()">delete</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the save file. </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="savefilejavadoc.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 SaveFile 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="savefilejavadoc.htm#exists()">exists</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Determines if the save file 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="savefilejavadoc.htm#getASP()">getASP</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the auxiliary storage pool ID for the save file.
</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;long</code></font></td>
<td><code><b><a href="savefilejavadoc.htm#getCurrentNumberOfRecords()">getCurrentNumberOfRecords</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current number of records in the save file.
</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="savefilejavadoc.htm#getDescription()">getDescription</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the text description of the save file.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;long</code></font></td>
<td><code><b><a href="savefilejavadoc.htm#getLength()">getLength</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the current total size (in bytes) of the save file.</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="savefilejavadoc.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 save file is located on the server.</td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;long</code></font></td>
<td><code><b><a href="savefilejavadoc.htm#getMaximumNumberOfRecords()">getMaximumNumberOfRecords</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the capacity (maximum number of records) of the save file.
</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="savefilejavadoc.htm#getName()">getName</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the name of the save file on the server.</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="savefilejavadoc.htm#getObjectDescription()">getObjectDescription</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an ObjectDescription instance representing the save file. </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="savefilejavadoc.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 save file.
</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="savefilejavadoc.htm#getSystem()">getSystem</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the system where the save file is located.</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="savefilejavadoc.htm#getTargetRelease()">getTargetRelease</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the
target release level of the operating system on which you intend to
restore and use the object(s) saved in the save file by a subsequent
invocation of one of the <tt>save()</tt> methods.
</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="savefilejavadoc.htm#getWaitTime()">getWaitTime</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the wait time for the save file. </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="savefilejavadoc.htm#isSaveOutput()">isSaveOutput</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates
whether output from called API's will be saved in the job's spooled
output. </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="savefilejavadoc.htm#isShared()">isShared</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reports
whether the open data path (ODP) for the save file is shared with other
programs in the routing step. </td>
</tr>
<tr class="TableRowColor" bgcolor="white">
<td align="right" valign="top" width="1%"><font size="-1">
<code>&nbsp;SaveFileEntry[]</code></font></td>
<td><code><b><a href="savefilejavadoc.htm#listEntries()">listEntries</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Lists the contents of the save file.
</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/Product.html">Product</a>[]</code></font></td>
<td><code><b><a href="savefilejavadoc.htm#listProducts()">listProducts</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Lists the product loads in the save file.
</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="savefilejavadoc.htm#refresh()">refresh</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Purges any cached attribute information about the save file.</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="savefilejavadoc.htm#renameTo(java.lang.String)">renameTo</a></b>(<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;Renames the save file. </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="savefilejavadoc.htm#restore(com.ibm.as400.access.Product)">restore</a></b>(<a href="javadoc/com/ibm/as400/access/Product.html">Product</a>&nbsp;product)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restores a
licenced program product that was saved into the save file. </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="savefilejavadoc.htm#restore(java.lang.String)">restore</a></b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;libraryName)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restores a library that was saved into the save file.
</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="savefilejavadoc.htm#restore(java.lang.String,java.lang.String%5B%5D,java.lang.String)">restore</a></b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;libraryName,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>[]&nbsp;objectList,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;toLibraryName)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Restores objects that were saved into the save file.
</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="savefilejavadoc.htm#save(com.ibm.as400.access.Product)">save</a></b>(<a href="javadoc/com/ibm/as400/access/Product.html">Product</a>&nbsp;product)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Saves a
copy of all of the objects that make up a licenced program product,
into the save file. </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="savefilejavadoc.htm#save(java.lang.String)">save</a></b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;libraryName)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Saves a library into the save file.
</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="savefilejavadoc.htm#save(java.lang.String%5B%5D)">save</a></b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>[]&nbsp;pathList)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Saves files from the root file system into the save file. </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="savefilejavadoc.htm#save(java.lang.String,java.lang.String%5B%5D)">save</a></b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;libraryName,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>[]&nbsp;objectList)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Saves objects into the save file.
</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="savefilejavadoc.htm#setDescription(java.lang.String)">setDescription</a></b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;description)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the text description of the save file.
</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="savefilejavadoc.htm#setMaximumNumberOfRecords(long)">setMaximumNumberOfRecords</a></b>(long&nbsp;maximumNumberOfRecords)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the capacity (maximum number of records) of the save file.
</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="savefilejavadoc.htm#setSaveOutput(boolean)">setSaveOutput</a></b>(boolean&nbsp;save)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Indicates
whether output from called API's will be saved in the job's spooled
output. </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="savefilejavadoc.htm#setShared(boolean)">setShared</a></b>(boolean&nbsp;shared)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets
whether the open data path (ODP) for the save file is shared with other
programs in the routing step. </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="savefilejavadoc.htm#setTargetRelease(java.lang.String)">setTargetRelease</a></b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;targetRelease)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the
target release level of the operating system on which you intend to
restore and use the object(s) saved in the save file by a subsequent
invocation of one of the <tt>save()</tt> methods.
</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="savefilejavadoc.htm#setWaitTime(int)">setWaitTime</a></b>(int&nbsp;seconds)</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the
number of seconds to wait for the file resources and session resources
to be allocated when the save file is opened, or for the device or
session resources to be allocated when an acquire operation is
performed to the save file. </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="savefilejavadoc.htm#toString()">toString</a></b>()</code>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the String representation of this object.</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#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="CURRENT_RELEASE"><!-- --></a></p><h3>
CURRENT_RELEASE</h3>
<pre>public static final <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a> <b>CURRENT_RELEASE</b></pre>
<dl>
<dd>Value for the "targetRelease" property, indicating "current
release". The object is to be restored to, and used on, the release of
the operating system currently running on the server. The object can
also be restored to a server with any subsequent release of the
operating system installed.
<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="PREVIOUS_RELEASE"><!-- --></a><h3>
PREVIOUS_RELEASE</h3>
<pre>public static final <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a> <b>PREVIOUS_RELEASE</b></pre>
<dl>
<dd>Value for the "targetRelease" property, indicating "previous
release". The object is to be restored to the previous release with
modification level 0 of the operating system. The object can also be
restored to a server with any subsequent release of the operating
system installed.
<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_MAX"><!-- --></a><h3>
NO_MAX</h3>
<pre>public static final long <b>NO_MAX</b></pre>
<dl>
<dd>Value for the "maximumNumberOfRecords" property, indicating that the system maximum is used.
<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="IMMED"><!-- --></a><h3>
IMMED</h3>
<pre>public static final int <b>IMMED</b></pre>
<dl>
<dd>Value for the "waitTime" property, indicating "immediate". The
program does not wait; when the file is opened, an immediate allocation
of the file resources is required.
<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="CLS"><!-- --></a><h3>
CLS</h3>
<pre>public static final int <b>CLS</b></pre>
<dl>
<dd>Special value for the "waitTime" property. Indicates that the job
default wait time is used as the wait time for the file resources being
allocated.
<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="DEFAULT"><!-- --></a><h3>
DEFAULT</h3>
<pre>public static final int <b>DEFAULT</b></pre>
<dl>
<dd>Special value for the "maximumNumberOfRecords", "waitTime", and
"asp" properties. Indicates that the system default value is used.
<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="SaveFile(com.ibm.as400.access.AS400, java.lang.String, java.lang.String)"><!-- --></a><h3>
SaveFile</h3>
<pre>public <b>SaveFile</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 SaveFile object.
<br>Note: This method does not create a save file on the server. To create a save file, use <a href="savefilejavadoc.htm#create()"><code>create()</code></a> or <a href="savefilejavadoc.htm#create(long,int,int,boolean,java.lang.String,java.lang.String)"><code>create()</code></a>.
<p>
</p></dd><dt><b>Parameters:</b></dt><dd><code>system</code> - The server where the save file is located.</dd><dd><code>library</code> - The library (on the server) where the save file is located. Example: "MYLIB1". Case is preserved.</dd><dd><code>name</code> - The name of the save file. Example: "MYFILE1". Case is preserved.</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="clear()"><!-- --></a><h3>
clear</h3>
<pre>public void <b>clear</b>()
throws <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/io/IOException.html">IOException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a>,
<a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></pre>
<dl>
<dd>Clears all existing records from the save file and reduces the amount of storage used by this file.
<p>
A save file must be cleared before it can be used again to receive data from a save command or to receive another save file.
</p><p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="copyTo(java.lang.String, java.lang.String)"><!-- --></a><h3>
copyTo</h3>
<pre>public void <b>copyTo</b>(<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)
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>Copies the save file to another save file on the same system.
<br>If the target save file doesn't exist on the server, it is created.
<br>If the target save file already contains data, the data is replaced.
<br>If the target exists but is not a save file, this method fails.
<br>If the target has insufficient capacity, an exception is thrown.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>library</code> - The library of the target save file. Example: "MYLIB1". Case is preserved.</dd><dd><code>name</code> - The name of the target save file. Example: "MYFILE1". Case is preserved.
</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 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/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/io/IOException.html">IOException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</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 a save file on the server.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<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/ObjectAlreadyExistsException.html">ObjectAlreadyExistsException</a></code> - If the save file already exists on the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the server API that queries save file description information is missing.</dd></dl>
</dd>
</dl>
<hr>
<a name="create(long, int, int, boolean, java.lang.String, java.lang.String)"><!-- --></a><h3>
create</h3>
<pre>public void <b>create</b>(long&nbsp;maxRecords,
int&nbsp;asp,
int&nbsp;waitTime,
boolean&nbsp;shared,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;authority,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;description)
throws <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/io/IOException.html">IOException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</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 a save file on the server.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>maxRecords</code> - The maximum number of records the save file can hold. If <a href="savefilejavadoc.htm#NO_MAX"><code>NO_MAX</code></a> is specified, the system maximum is used.</dd><dd><code>asp</code> - The auxiliary storage pool (ASP) in which the system creates the save file. If <a href="savefilejavadoc.htm#DEFAULT"><code>DEFAULT</code></a> is specified, the save file is created in the same ASP as the one containing the library holding the file.</dd><dd><code>waitTime</code>
- The number of seconds that the program waits for the file resources
and session resources to be allocated when the file is opened, or for
the device or session resources to be allocated when an acquire
operation is performed to the file. Special values: <a href="savefilejavadoc.htm#CLS"><code>CLS</code></a>, <a href="savefilejavadoc.htm#IMMED"><code>IMMED</code></a></dd><dd><code>shared</code>
- Specifies whether the open data path (ODP) for the save file is
shared with other programs in the routing step. When an ODP is shared,
the programs accessing the file share facilities such as the file
status and the buffer. Default is false.</dd><dd><code>authority</code>
- The authority given to users who do not have specific authority to
the save file, who are not on an authorization list, and whose user
group has no specific authority to the save file. Defaults to *EXCLUDE
if null.</dd><dd><code>description</code> - The text that briefly describes the save file. Defaults to blank if <tt>null</tt>.
</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/ObjectAlreadyExistsException.html">ObjectAlreadyExistsException</a></code> - If the save file already exists on the server.
</dd><dd><code><a href="javadoc/com/ibm/as400/access/ObjectDoesNotExistException.html">ObjectDoesNotExistException</a></code> - If the server API that queries save file description information is missing.</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/io/IOException.html">IOException</a>,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/InterruptedException.html">InterruptedException</a></pre>
<dl>
<dd>Deletes the save file. If the save file does not exist, does nothing.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<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></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 SaveFile 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 save file currently exists on the system.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>true if the save file exists; false if the save file 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 save file description information is missing.</dd></dl>
</dd>
</dl>
<hr>
<a name="getASP()"><!-- --></a><h3>
getASP</h3>
<pre>public int <b>getASP</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 auxiliary storage pool ID for the save file.
<br>If the save file doesn't exist on the server, an exception is thrown.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>The auxiliary storage pool ID.
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="getCurrentNumberOfRecords()"><!-- --></a><h3>
getCurrentNumberOfRecords</h3>
<pre>public long <b>getCurrentNumberOfRecords</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 current number of records in the save file.
<br>If the save file doesn't exist on the server, an exception is thrown.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>The current number of records in the save file.
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="getDescription()"><!-- --></a><h3>
getDescription</h3>
<pre>public <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a> <b>getDescription</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 text description of the save file.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>The text description.
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="getLength()"><!-- --></a><h3>
getLength</h3>
<pre>public long <b>getLength</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 current total size (in bytes) of the save file.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>The size of the save file.
</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 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 save file is located on the server.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>The name of the library</dd></dl>
</dd>
</dl>
<hr>
<a name="getMaximumNumberOfRecords()"><!-- --></a><h3>
getMaximumNumberOfRecords</h3>
<pre>public long <b>getMaximumNumberOfRecords</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 capacity (maximum number of records) of the save file.
Returns <a href="savefilejavadoc.htm#NO_MAX"><code>NO_MAX</code></a> if there is no maximum.
<br>If the save file doesn't exist on the server, an exception is thrown.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>The maximum number of records that the save file can hold.
</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 object does not exist on the server.</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 name of the save file on the server.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>The name of the save file</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>()
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 an ObjectDescription instance representing the save file.
Various attributes of the save file can then be queried via the
ObjectDescription.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>An ObjectDescription representing the save file.
</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 object does not exist on the server.</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 save file.
Example: "/QSYS.LIB/MYLIB1.LIB/MYFILE1.SAVF"
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>The path of the save file.</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 save file is located.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>The system.</dd></dl>
</dd>
</dl>
<hr>
<a name="getTargetRelease()"><!-- --></a><h3>
getTargetRelease</h3>
<pre>public <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a> <b>getTargetRelease</b>()</pre>
<dl>
<dd>Returns the target release level of the operating system on which
you intend to restore and use the object(s) saved in the save file by a
subsequent invocation of one of the <tt>save()</tt> methods. The
format VxRxMx is used to specify the target release, where Vx is the
version, Rx is the release, and Mx is the modification level. For
example, V5R2M0 is version 5, release 2, modification level 0. Special
values include <a href="savefilejavadoc.htm#CURRENT_RELEASE"><code>CURRENT_RELEASE</code></a> and <a href="savefilejavadoc.htm#PREVIOUS_RELEASE"><code>PREVIOUS_RELEASE</code></a>. The default is CURRENT_RELEASE.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
</dl>
</dd>
</dl>
<hr>
<a name="getWaitTime()"><!-- --></a><h3>
getWaitTime</h3>
<pre>public int <b>getWaitTime</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 wait time for the save file. This is the number of
seconds to wait for the file resources and session resources to be
allocated when the save file is opened, or for the device or session
resources to be allocated when an acquire operation is performed to the
save file. <br>Special values: <a href="savefilejavadoc.htm#IMMED"><code>IMMED</code></a>, <a href="savefilejavadoc.htm#CLS"><code>CLS</code></a>
<br>If the save file doesn't exist on the server, an exception is thrown.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>The wait time.
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="isSaveOutput()"><!-- --></a><h3>
isSaveOutput</h3>
<pre>public boolean <b>isSaveOutput</b>()</pre>
<dl>
<dd>Indicates whether output from called API's will be saved in the job's spooled output.
<br>By default, output is not saved.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
</dl>
</dd>
</dl>
<hr>
<a name="isShared()"><!-- --></a><h3>
isShared</h3>
<pre>public boolean <b>isShared</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>Reports whether the open data path (ODP) for the save file is
shared with other programs in the routing step. When an ODP is shared,
the programs accessing the file, share facilities such as the file
status and the buffer. <br>The default is "not shared".
<br>If the save file doesn't exist on the server, an exception is thrown.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="listEntries()"><!-- --></a><h3>
listEntries</h3>
<pre>public SaveFileEntry[] <b>listEntries</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="http://java.sun.com/j2se/1.4.2/docs/api/java/io/UnsupportedEncodingException.html">UnsupportedEncodingException</a></pre>
<dl>
<dd>Lists the contents of the save file.
<br>Note: Due to a
limitation in the underlying API (QSRLSAVF). files saved from the
"root" file system ("/") cannot be listed. Use the DSPSAVF to view the
contents of such save files.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>The entries in the save file.
</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 object does not exist on the server.
</dd><dd><code><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/UnsupportedEncodingException.html">UnsupportedEncodingException</a></code></dd></dl>
</dd>
</dl>
<hr>
<a name="listProducts()"><!-- --></a><h3>
listProducts</h3>
<pre>public <a href="javadoc/com/ibm/as400/access/Product.html">Product</a>[] <b>listProducts</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>Lists the product loads in the save file.
If the save file contains no product loads, returns an empty list.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Returns:</b></dt><dd>The product loads in the save file.
</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 object does not exist on the server.</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>Purges any cached attribute information about the save file.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="renameTo(java.lang.String)"><!-- --></a><h3>
renameTo</h3>
<pre>public void <b>renameTo</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;name)
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>Renames the save file. The library is not changed.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>name</code> - The new name for the save file. Example: "MYFILE1".
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="restore(java.lang.String)"><!-- --></a><h3>
restore</h3>
<pre>public void <b>restore</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;libraryName)
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>Restores a library that was saved into the save file.
If the library does not exist, it is created.
If the save file does not contain a library named <tt>libraryName</tt>, an exception is thrown.
<br>Note:
This method presents a subset of the functionality of the 'RSTLIB' CL
command. For full functionality, call the CL directly using the
CommandCall class.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>libraryName</code> - The library to be restored.
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="restore(java.lang.String, java.lang.String[], java.lang.String)"><!-- --></a><h3>
restore</h3>
<pre>public void <b>restore</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;libraryName,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>[]&nbsp;objectList,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;toLibraryName)
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>Restores objects that were saved into the save file.
If the target library does not exist, it is created.
If the save file does not contain the specified library or object, an exception is thrown.
<br>Note:
This method presents a subset of the functionality of the 'RSTOBJ' CL
command. For full functionality, call the CL directly using the
CommandCall class.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>libraryName</code> - The library from which the object was saved.</dd><dd><code>objectList</code> - The objects to be restored. Objects are specified by simple object name. For example: MYPROG1 or MYFILE2.</dd><dd><code>toLibraryName</code>
- The library to which to restore the object. If null, restores to the
original library, that is, the library from which the object was saved.
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="restore(com.ibm.as400.access.Product)"><!-- --></a><h3>
restore</h3>
<pre>public void <b>restore</b>(<a href="javadoc/com/ibm/as400/access/Product.html">Product</a>&nbsp;product)
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>Restores a licenced program product that was saved into the save file.
If the save file does not contain the specified product, an exception is thrown.
<br>Note:
This method presents a subset of the functionality of the 'RSTLICPGM'
CL command. For full functionality, call the CL directly using the
CommandCall class.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>product</code> - The product to be restored.
</dd><dt><b>Throws:</b>
</dt><dd><code><a href="javadoc/com/ibm/as400/access/AS400Exception.html">AS400Exception</a></code> - If the product is already installed, or 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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="save(java.lang.String)"><!-- --></a><h3>
save</h3>
<pre>public void <b>save</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;libraryName)
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>Saves a library into the save file.
Any existing data in the save file is cleared.
If libraryName does not specify an existing library, an exception is thrown.
<br>Note:
This method presents a subset of the functionality of the 'SAVLIB' CL
command. For full functionality, call the CL directly using the
CommandCall class.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>libraryName</code> - The library to be saved.
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="save(java.lang.String, java.lang.String[])"><!-- --></a><h3>
save</h3>
<pre>public void <b>save</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;libraryName,
<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>[]&nbsp;objectList)
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>Saves objects into the save file.
Any existing data in the save file is cleared.
If a specified library or object does not exist, an exception is thrown.
<br>Note:
This method presents a subset of the functionality of the 'SAVOBJ' CL
command. For full functionality, call the CL directly using the
CommandCall class.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>libraryName</code> - The library where the object resides.</dd><dd><code>objectList</code> - The objects to be saved. Objects are specified by simple object name. For example: MYPROG1 or MYFILE2.
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="save(java.lang.String[])"><!-- --></a><h3>
save</h3>
<pre>public void <b>save</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>[]&nbsp;pathList)
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>Saves files from the root file system into the save file. The
objects are specified by their fully qualified pathname in the
Integrated File System. Wildcard characters ("*") may be used. Any
existing data in the save file is cleared. If a specified object does
not exist, an exception is thrown. <br>Note: The objects must all reside in the root file system
("/"). This method will throw an exception if pathList specifies files
under QSYS or QDLS. <br>Note: This method presents a subset of the functionality of
the 'SAV' CL command. For full functionality, call the CL directly
using the CommandCall class.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>pathList</code> - The objects to be saved; objects are specified by path. For example: "/myDirectory/myFile" or "/myDirectory/*".
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="save(com.ibm.as400.access.Product)"><!-- --></a><h3>
save</h3>
<pre>public void <b>save</b>(<a href="javadoc/com/ibm/as400/access/Product.html">Product</a>&nbsp;product)
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>Saves a copy of all of the objects that make up a licenced program product, into the save file.
Any existing data in the save file is cleared.
If the product does not exist, an exception is thrown.
<br>Note: Depending on the size of the product, this method may take a <em>very</em> long time to complete.
<br>Note:
This method presents a subset of the functionality of the 'SAVLICPGM'
CL command. For full functionality, call the CL directly using the
CommandCall class.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>product</code> - The product to be saved.
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="setDescription(java.lang.String)"><!-- --></a><h3>
setDescription</h3>
<pre>public void <b>setDescription</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;description)
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 text description of the save file.
If the save file doesn't exist on the server, an exception is thrown.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>description</code> - The description.
Maximum length is 50 characters.
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="setMaximumNumberOfRecords(long)"><!-- --></a><h3>
setMaximumNumberOfRecords</h3>
<pre>public void <b>setMaximumNumberOfRecords</b>(long&nbsp;maximumNumberOfRecords)
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 capacity (maximum number of records) of the save file.
<br>If
the current number of records in the save file is greater than the new
maximumNumberOfRecords value, an exception is thrown, and the save file
is not changed. <br>Special value: <a href="savefilejavadoc.htm#NO_MAX"><code>NO_MAX</code></a>
<br>If the save file doesn't exist on the server, an exception is thrown.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="setSaveOutput(boolean)"><!-- --></a><h3>
setSaveOutput</h3>
<pre>public void <b>setSaveOutput</b>(boolean&nbsp;save)</pre>
<dl>
<dd>Indicates whether output from called API's will be saved in the
job's spooled output. The job will be that of the Remote Command Host
Server, job QUSRWRK/QZRCSRVS. The saved information may be useful when
analyzing errors. <br>By default, output is not saved.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>save</code> - Whether output should be saved.</dd></dl>
</dd>
</dl>
<hr>
<a name="setShared(boolean)"><!-- --></a><h3>
setShared</h3>
<pre>public void <b>setShared</b>(boolean&nbsp;shared)
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 whether the open data path (ODP) for the save file is shared
with other programs in the routing step. When an ODP is shared, the
programs accessing the file can share facilities such as the file
status and the buffer. For more details refer to the specification of
the <tt>CHGSAVF</tt> CL command in the i5/OS reference.
If the save file doesn't exist on the server, an exception is thrown.
<br>The default is "not shared".
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>shared</code> - Whether ODP is shared.
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="setTargetRelease(java.lang.String)"><!-- --></a><h3>
setTargetRelease</h3>
<pre>public void <b>setTargetRelease</b>(<a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a>&nbsp;targetRelease)</pre>
<dl>
<dd>Sets the target release level of the operating system on which you
intend to restore and use the object(s) saved in the save file by a
subsequent invocation of one of the <tt>save()</tt> methods. The
format VxRxMx is used to specify the target release, where Vx is the
version, Rx is the release, and Mx is the modification level. For
example, V5R2M0 is version 5, release 2, modification level 0. <br>The object(s) in the save file can be restored to a server
with the specified release or with any subsequent release of the
operating system installed. Valid values depend on the server's current
version, release, and modification level. Special values include <a href="savefilejavadoc.htm#CURRENT_RELEASE"><code>CURRENT_RELEASE</code></a> and <a href="savefilejavadoc.htm#PREVIOUS_RELEASE"><code>PREVIOUS_RELEASE</code></a>. The default is CURRENT_RELEASE.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>targetRelease</code> - The target release.</dd></dl>
</dd>
</dl>
<hr>
<a name="setWaitTime(int)"><!-- --></a><h3>
setWaitTime</h3>
<pre>public void <b>setWaitTime</b>(int&nbsp;seconds)
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 number of seconds to wait for the file resources and
session resources to be allocated when the save file is opened, or for
the device or session resources to be allocated when an acquire
operation is performed to the save file. <br>The default is <a href="savefilejavadoc.htm#IMMED"><code>IMMED</code></a>.
<br>If the save file doesn't exist on the server, an exception is thrown.
<p>
</p></dd><dd><dl>
</dl>
</dd>
<dd><dl>
<dt><b>Parameters:</b></dt><dd><code>seconds</code> - The wait time.
</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 object does not exist on the server.</dd></dl>
</dd>
</dl>
<hr>
<a name="toString()"><!-- --></a><h3>
toString</h3>
<pre>public <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/lang/String.html">String</a> <b>toString</b>()</pre>
<dl>
<dd>Returns the String representation of this 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#toString()">toString</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>The String representation of this object.</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/RootPermission.html"><b>PREV CLASS</b></a>&nbsp;
&nbsp;<a href="javadoc/com/ibm/as400/access/SCS3812Writer.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="savefilejavadoc.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>