Package | Description |
---|---|
com.ibm.as400.access |
Provides classes that represent various IBM i data and resources.
|
com.ibm.as400.security.auth |
Provides user profile swapping using IBM i profile token and credential
classes.
|
com.ibm.as400.util |
Provides various utility applications and classes.
|
com.ibm.as400.vaccess |
Deprecated Provides classes that graphically present IBM i data to the
user.
|
Modifier and Type | Class | Description |
---|---|---|
class |
ErrnoException |
The ErrnoException class represents an exception that indicates that an errno has been returned by a system API.
|
Modifier and Type | Method | Description |
---|---|---|
void |
AS400File.addPhysicalFileMember(String name,
String textDescription) |
Adds a physical file member to the file represented by this object.
|
boolean |
Product.allowsDynamicNaming() |
Indicates if the names of product libraries and root folders
for this product option can be dynamically changed without
causing a product error.
|
boolean |
Command.allowsLimitedUser() |
Indicates whether or not a user with limited authorities is allowed to run this command.
|
boolean |
Product.allowsMixedReleases() |
Indicates if this product allows mixed releases between its *BASE
and options.
|
boolean |
Product.allowsMultipleReleases() |
Indicates if this product can be installed at a release level different
from the current release level without installing over a current release.
|
void |
SpooledFile.answerMessage(String reply) |
Replies to the message that caused the spooled file to wait.
|
void |
Subsystem.assignPool(int sequenceNumber,
int size,
int activityLevel) |
Defines a private storage pool and adds it to the list of storage pools defined for the subsystem.
|
void |
Subsystem.assignPool(int sequenceNumber,
String poolName) |
Adds a shared system pool to the list of storage pools defined for the subsystem.
|
void |
Subsystem.changeDescriptionText(String text) |
Sets the subsystem description text.
|
void |
Subsystem.changeDisplayFilePath(String path) |
Specifies the signon display file that is used when showing signon displays at work stations allocated to the subsystem.
|
void |
Subsystem.changeLanguageLibrary(String library) |
Specifies a library to enter ahead of other libraries in the system portion of the library list.
|
void |
Subsystem.changeMaximumActiveJobs(int maxJobs) |
Sets the maximum number of active jobs that can run or use resources within the subsystem at one time.
|
void |
OutputQueue.clear(PrintParameterList clearOptions) |
Clears the output queue on the system.
|
void |
AS400File.close() |
Closes the file on the system.
|
void |
ClusteredHashTable.close() |
Closes a connection to the Clustered Hash Table server.
|
void |
ObjectList.close() |
Closes the object list on the system.
|
void |
AS400File.commit() |
Commits all transactions since the last commit boundary.
|
static void |
AS400File.commit(AS400 system) |
Commits all transactions since the last commit boundary for the specified system.
|
void |
Permission.commit() |
Commits the permission changes to the system.
|
void |
SystemPool.commitCache() |
Commits any cached system pool information changes to the system.
|
boolean |
ClusteredHashTable.containsKey(byte[] key) |
Indicates if the specified key is in the clustered hash table.
|
SpooledFile |
SpooledFile.copy() |
Creates a copy of the spooled file this (SpooledFile) object represents.
|
SpooledFile |
SpooledFile.copy(OutputQueue outputQueue) |
Creates a copy of the spooled file this object represents.
|
void |
SaveFile.copyTo(String library,
String name) |
Copies the save file to another save file on the same system.
|
void |
AS400File.create(int recordLength,
String fileType,
String textDescription) |
Creates a physical file with the specified record length and file type.
|
void |
AS400File.create(RecordFormat recordFormat,
String textDescription) |
Creates a physical file using the specified record format.
|
void |
AS400File.create(RecordFormat recordFormat,
String textDescription,
String altSeq,
String ccsid,
String order,
String ref,
boolean unique,
String format,
String text) |
Creates a physical file using the specified record format and any specified
keywords.
|
void |
AS400File.create(String ddsSourceFile,
String textDescription) |
Creates a physical file using the specified DDS source file.
|
void |
Subsystem.create() |
Creates the subsystem on the system.
|
void |
Subsystem.create(String authority) |
Creates the subsystem on the system.
|
void |
AS400FileRecordDescription.createRecordFormatSource(String filePath,
String packageName) |
Retrieves the file description for the file, and creates a file containing the Java source for
a class extending from RecordFormat that represents the record format for the file.
|
void |
AS400File.delete() |
Deletes the file.
|
void |
SaveFile.delete() |
Deletes the save file.
|
void |
SpooledFile.delete() |
Deletes the spooled file on the system.
|
void |
Subsystem.delete() |
Deletes the subsystem from the system.
|
void |
AS400File.deleteCurrentRecord() |
Deletes the record at the current cursor position.
|
void |
AS400File.deleteMember() |
Deletes the member associated with this object from the file.
|
void |
KeyedFile.deleteRecord(byte[] key,
int numberOfKeyFields) |
Deletes the record specified by key.
|
void |
KeyedFile.deleteRecord(Object[] key) |
Deletes the record specified by key.
|
void |
SequentialFile.deleteRecord(int recordNumber) |
Deletes the record specified by record number.
|
ClusteredHashTableEntry[] |
ClusteredHashTable.elements() |
Retrieves a list of entries that exist in the clustered hash table for the specified user profile.
|
ClusteredHashTableEntry[] |
ClusteredHashTable.elements(String userProfile,
String lastModifiedProfile,
int status) |
Retrieves a list of entries that exist in the clustered hash table for the specified user profile.
|
void |
ISeriesNetServer.enableUser(String user) |
Enable a single user for NetServer
|
void |
ISeriesNetServer.enableUsers(String[] users) |
Enables a set of users for NetServer
This method requires *IOSYSCFG special authority and authority to the user profiles on the system. |
void |
Subsystem.end(int timeLimit) |
Ends the subsystem on the system, in a controlled manner.
|
void |
WriterJob.end(String endType) |
Ends a writer on the system.
|
static void |
Subsystem.endAllSubsystems(AS400 system,
int timeLimit) |
Ends all active subsystems on the system, in a controlled manner.
|
static void |
Subsystem.endAllSubsystemsImmediately(AS400 system) |
Ends all active subsystems on the system, immediately.
|
void |
AS400File.endCommitmentControl() |
Ends commitment control for this connection.
|
static void |
AS400File.endCommitmentControl(AS400 system) |
Ends commitment control for the specified connection.
|
void |
Subsystem.endImmediately() |
Ends the subsystem on the system, immediately.
|
boolean |
JobDescription.exists() |
Determines if the Job Description currently exists on the system.
|
boolean |
JobQueue.exists() |
Determines if the subsystem currently exists on the system.
|
boolean |
ObjectDescription.exists() |
Checks to see if this object currently exists on the system.
|
boolean |
SaveFile.exists() |
Determines if the save file currently exists on the system.
|
boolean |
Subsystem.exists() |
Determines if the subsystem currently exists on the system.
|
byte[] |
ClusteredHashTable.generateKey() |
Generates a 16-byte universally unique key.
|
Command[] |
CommandList.generateList() |
Generate a list of commands.
|
ClusteredHashTableEntry |
ClusteredHashTable.get(byte[] key) |
Returns information from the clustered hash table for the specified key.
|
String |
PTF.getActionRequired() |
Returns the action required to make this PTF active when it is applied.
|
String |
JavaProgram.getAdoptedAuthorityProfile() |
Returns the profile to use when the "Use Adopted Authority" field is set.
|
PrintObjectInputStream |
SpooledFile.getAFPInputStream() |
Returns an input stream that can be used to read the contents of an
AFP spooled file.
|
String[] |
PTF.getAPARNumbers() |
Retrieves the list of APAR numbers that were fixed by this PTF.
|
int |
SaveFile.getASP() |
Returns the auxiliary storage pool ID for the save file.
|
int |
Command.getCCSID() |
Returns the coded character set ID (CCSID) associated with this command.
|
String |
Command.getCommandProcessingProgram() |
Returns the fully qualified integrated file system path of the program
that accepts parameters from this command processes this command.
|
String |
Command.getCommandProcessingState() |
Returns the state from which the command processing program is called.
|
Reader |
PTFCoverLetter.getContents() |
Returns a Reader object that can be used to read the contents
of this cover letter.
|
static String |
NLS.getCountryDescription(AS400 system,
String countryID) |
Retrieves the descriptive text for the specified country or region identifier.
|
PTFCoverLetter |
PTF.getCoverLetter() |
Retrieves the cover letter for this PTF from the system.
|
PTFCoverLetter |
PTF.getCoverLetter(Locale locale) |
Retrieves the cover letter for this PTF from the system based on the given locale.
|
PTFCoverLetter[] |
PTF.getCoverLetters() |
Retrieves the cover letters for this PTF from the system, if they exist.
|
Date |
PTF.getCreationDate() |
Returns the date and time that the PTF was created.
|
String |
Product.getCurrentCopyright() |
Returns the value specified for the copyright current year when
the product definition for this product load was created.
|
String |
PTF.getCurrentIPLSource() |
Returns the copy of Licensed Internal Code that the system is currently
operating from.
|
String |
Command.getCurrentLibrary() |
Returns the library used as the current library during the processing of this
command.
|
long |
SaveFile.getCurrentNumberOfRecords() |
Returns the current number of records in the save file.
|
PTF[] |
PTF.getDependentPTFs() |
Retrieves the list of PTFs that are dependent upon this PTF.
|
String |
Command.getDescription() |
Returns the user text used to briefly describe this command and its function.
|
String |
SaveFile.getDescription() |
Returns the text description of the save file.
|
String |
Product.getDescriptionID() |
Returns the message ID associated with this product option.
|
String |
Product.getDescriptionMessageFile() |
Returns the full pathname of the message file that contains the
messages describing the product and its options.
|
String |
Product.getDescriptionText() |
Retrieves the description text for this product's message ID out of
this product's message file.
|
ProductDirectoryInformation[] |
Product.getDirectoryInformation() |
Returns the list of product directories for this product.
|
String[] |
ISeriesNetServer.getDisabledUsers() |
Return a list of users that are disabled for NetServer
This method requires *IOSYSCFG special authority on the system. |
DirectoryEntry[] |
DirectoryEntryList.getEntries() |
Retrieves the directory entry information from the system.
|
PTFExitProgram[] |
PTF.getExitPrograms() |
Retrieves the list of exit programs for this PTF.
|
String |
Product.getFeatureID() |
Returns the feature ID for this product.
|
Date |
JavaProgram.getFileChangeDate() |
Returns the date and time the file was last modified or changed.
|
String |
JavaProgram.getFileOwner() |
Returns the name of the owner of the file.
|
String |
Product.getFirstCopyright() |
Returns the value specified for the copyright first year when
the product definition for this product load was created.
|
Float |
PrintObject.getFloatAttribute(int attributeID) |
Returns an attribute of the object that is a Float type attribute.
|
String |
Command.getHelpIdentifier() |
Returns the name of the general help module for the names of the help
identifiers for this command.
|
PanelGroupHelpIdentifier[] |
PanelGroup.getHelpIdentifiers(String[] keywords) |
Returns the panel group help identifiers for the specified keywords.
|
PanelGroup |
Command.getHelpPanelGroup() |
Returns the fully integrated file system path of the help panel group in which
the online help information exists for this command.
|
String |
Command.getHelpSearchIndex() |
Returns the fully qualified integrated file system path of the help search index
used for this command.
|
String |
PanelGroup.getHelpText(String[] keywords) |
Retrieves the XML help text from the system for the specified keywords.
|
PrintObjectInputStream |
SpooledFile.getInputACIFMergedStream(boolean acifB) |
Deprecated.
Use getAFPInputStream() instead.
|
PrintObjectInputStream |
AFPResource.getInputStream() |
Returns an input stream that can be used to read the contents of the
AFP resource.
|
PrintObjectInputStream |
SpooledFile.getInputStream() |
Returns an input stream that can be used to read the contents of the
spooled file.
|
PrintObjectInputStream |
SpooledFile.getInputStream(PrintParameterList ppl) |
Returns an input stream that can be used to read the contents of the
spooled file.
|
Integer |
PrintObject.getIntegerAttribute(int attributeID) |
Returns an attribute of the object that is a Integer type attribute.
|
int |
PTF.getIPLAction() |
Returns the action to be taken on this PTF during the next IPL.
|
String |
PTF.getIPLRequired() |
Returns the type of PTF (delayed or immediate).
|
Date |
JavaProgram.getJavaProgramCreationDate() |
Returns the date and time the Java program was created for the file.
|
String |
JavaProgram.getJavaProgramVersion() |
Returns the IBM i version the Java program was created for.
|
Job[] |
JobList.getJobs(int listOffset,
int number) |
Returns a subset of the list of jobs in the job list.
|
static String |
NLS.getLanguageDescription(AS400 system,
String languageID) |
Retrieves the descriptive text for the specified language identifier.
|
String |
Subsystem.getLanguageLibrary() |
Returns the library that is entered ahead of other libraries in the system portion of the library list.
|
int |
ObjectList.getLength() |
Returns the number of objects in the object list.
|
long |
SaveFile.getLength() |
Returns the current total size (in bytes) of the save file.
|
String |
Product.getLevel() |
Returns the release level of this product.
|
ProductLicense |
Product.getLicense() |
Returns a ProductLicense object representing license information
for this product.
|
String |
PTF.getLICGroup() |
Returns the name of the Licensed Internal Code Group for this PTF.
|
String |
JavaProgram.getLICOptions() |
Returns the LIC options string specified when the java program was last modified.
|
String |
PTF.getLoadedStatus() |
Returns the current loaded status of this PTF.
|
String |
PTF.getLoadedStatusMessage(String loadedStatus) |
Returns the translated description text for the specified status.
|
String |
Product.getLoadState() |
Returns the state of the product load for which information was retrieved.
|
String |
Product.getLoadType() |
Returns the type of product load for which information was retrieved.
|
String |
PTF.getMaximumLevel() |
Returns the highest release level of the product on which this
PTF can be installed.
|
long |
SaveFile.getMaximumNumberOfRecords() |
Returns the capacity (maximum number of records) of the save file.
|
int |
Command.getMaximumPositionalParameters() |
Returns the maximum number of parameters that can be coded in a positional
manner for this command.
|
AS400Message |
SpooledFile.getMessage() |
Returns the message that is associated with this spooled file.
|
MessageFile |
Command.getMessageFile() |
Returns a MessageFile object representing the message file
from which messages identified on the DEP statements used to define the command
are retrieved.
|
String |
PTF.getMinimumLevel() |
Returns the lowest release level of the product on which this
PTF can be installed.
|
String |
Product.getMinimumRequiredRelease() |
Returns the minimum release level that is allowed for the option
that will run with the current level of the *BASE option for the product.
|
String |
Product.getMinimumRequiredReleaseForBase() |
Returns the minimum release level that is allowed for the *BASE option
that will run with the current level of the option for the product.
|
String |
Product.getMinimumTargetRelease() |
Returns the minimum operating system release to which the Save Licensed Program
(SAVLICPGM) command will allow the product to be saved.
|
byte |
Command.getMultithreadedJobAction() |
Returns the action taken when a command that is not threadsafe is called in
a multithreaded job.
|
int |
JavaProgram.getNumberOfAttachedPrograms() |
Returns the number of Java prgroams attached to the .class or .jar/sip file.
|
int |
JavaProgram.getNumberOfClasses() |
Returns the number of classes.
|
int |
JavaProgram.getNumberOfClassesWithCurrentJavaPrograms() |
Returns the number of classes with representations up-to-date in the attached Java programs.
|
int |
JavaProgram.getNumberOfClassesWithErrors() |
Returns the number of classes containing errors.
|
int |
JavaProgram.getNumberOfClassesWithoutCurrentJavaPrograms() |
Returns the number of classes with representations out-of-date.
|
ObjectDescription |
SaveFile.getObjectDescription() |
Returns an ObjectDescription instance representing the save file.
|
UserObjectsOwnedListEntry[] |
UserObjectsOwnedList.getObjectList() |
Returns a list of all UserObjectsOwnedListEntry IBM i objects based on the current
selection criteria for the file system and object relation.
|
ObjectLockListEntry[] |
ObjectDescription.getObjectLockList() |
Returns a list of all ObjectLockListEntry objects representing possible Object Locks on this ObjectDescription.
|
Enumeration |
ObjectList.getObjects() |
Returns the list of objects in the object list.
|
ObjectDescription[] |
ObjectList.getObjects(int listOffset,
int number) |
Returns a subset of the list of objects.
|
int |
JavaProgram.getOptimizationLevel() |
Returns the optimization level used to create the java program.
|
PrintObjectPageInputStream |
SpooledFile.getPageInputStream(PrintParameterList pageStreamOptions) |
Returns a page input stream that can be used to read the contents of the
spooled file, one page at a time.
|
String |
JavaProgram.getPerformanceCollectionEnabledFlag() |
Returns whether or not performance collection is enabled.
|
String |
JavaProgram.getPerformanceCollectionType() |
Returns the type of performance collection if the performance collection flag is set.
|
Permission |
IFSFile.getPermission() |
Returns the permission of the object.
|
String |
Product.getPrimaryLanguageFeatureID() |
Returns the primary language feature ID for this product.
|
String |
PTF.getProductFeature() |
Returns the product feature to which this PTF applies.
|
String |
PTF.getProductID() |
Returns the product ID of this PTF.
|
String |
Command.getProductLibrary() |
Returns the library that is in effect during the processing of the command.
|
String |
PTF.getProductOption() |
Returns the product option to which this PTF applies.
|
Product[] |
Product.getProductOptions() |
Returns the list of product options for this product ID.
|
Product[] |
ProductList.getProducts() |
Retrieves the list of products from the system.
|
String |
JavaProgram.getProfilingDataStatus() |
Returns whether profiling data is enabled or applied.
|
MessageFile |
Command.getPromptMessageFile() |
Returns a MessageFile object representing the message file
that contains the prompt text for this command.
|
String |
Command.getPromptOverrideProgram() |
Returns the fully qualified integrated file system path of the program
that replaces default values on the prompt display with the current
actual values for the parameter.
|
String |
Command.getPromptOverrideState() |
Returns the state from which the prompt override program is called.
|
PTFGroup[] |
PTFGroupList.getPTFGroup() |
Returns a list of all PTF groups that are known to the system.
|
String |
PTFGroup.getPTFGroupDescription() |
Returns the description for the PTF group.
|
int |
PTFGroup.getPTFGroupLevel() |
Returns the PTF group level.
|
String |
PTFGroup.getPTFGroupName() |
Returns the PTF group name.
|
int |
PTFGroup.getPTFGroupStatus() |
Indicates the overall status of the PTF group on this system.
|
PTF[] |
Product.getPTFs(boolean includeSupersededPTFs) |
Returns the list of Program Temporary Fixes (PTFs) on
the system for this product.
|
PTF[] |
PTFGroup.getPTFs() |
|
String |
Product.getRegistrationType() |
Returns the registration type associated with this product.
|
String |
Product.getRegistrationValue() |
Returns the registration value associated with this product.
|
PTFGroup[] |
PTFGroup.getRelatedPTFGroups() |
Returns a list of related PTF groups.
|
String |
PTF.getRelationship(PTF ptf) |
Returns the relationship between this PTF and another PTF.
|
Date |
Product.getReleaseDate() |
Returns the value specified for the release date when the product
definition for this product load was created.
|
String |
Product.getReleaseLevel() |
Returns the release level for this product.
|
String |
PTF.getReleaseLevel() |
Returns the release level of this PTF.
|
int |
Product.getRequirementsMet() |
Returns the reason why the release requirements between the base and
option may or may not be in error.
|
PTF[] |
PTF.getRequisitePTFs() |
Retrieves the list of pre- and co-requisite PTFs for this PTF.
|
String |
Command.getRestrictedRelease() |
Returns the version, release, and modification level to which this command is
restricted.
|
String |
PTF.getSaveFile() |
Returns the full pathname of the save file for this PTF, if one exists.
|
int |
PTF.getServerIPLRequired() |
Indicates whether a server IPL must be performed in order to activate
the changes for the PTF.
|
Float |
PrintObject.getSingleFloatAttribute(int attributeID) |
Returns an attribute of the object that is a Float type attribute.
|
Integer |
PrintObject.getSingleIntegerAttribute(int attributeID) |
Returns an attribute of the object that is a Integer type attribute.
|
String |
PrintObject.getSingleStringAttribute(int attributeID) |
Returns an attribute of the object that is a String type attribute.
|
int |
JavaProgram.getSizeOfAttachedJavaPrograms() |
Returns the size in kilobytes of all the attached java programs.
|
String |
Command.getSourceFile() |
Returns the fully qualified integrated file system path of the
source file member that contains the command definition statements
used to create this command.
|
Date |
PTF.getStatusDate() |
Returns the date and time the PTF status last changed.
|
String |
PrintObject.getStringAttribute(int attributeID) |
Returns an attribute of the object that is a String type attribute.
|
String |
PTF.getSupersededByPTF() |
Returns the PTF ID that has replaced this PTF.
|
PTF[] |
PTF.getSupersededPTFs() |
Retrieves the list of PTFs that are supserseded by this PTF.
|
String |
PTF.getSupersedingPTF() |
Returns the PTF ID of the most recent supersede of this PTF that exists on the system.
|
String |
Product.getSymbolicLoadState() |
Returns the symbolic load state for which information was retrieved.
|
String[] |
PTF.getSymptomStrings() |
Returns the list of symptom strings for the problems fixed by this PTF.
|
String |
PTF.getTargetRelease() |
Returns the earliest release of the operating system on which you can load and apply
this PTF.
|
boolean |
PTF.getTechRefreshPTF() |
Deprecated.
Use isTechRefreshPTF() instead.
|
byte |
Command.getThreadSafety() |
Returns the type of threadsafety for this command; that is, whether or not this command
can be used safely in a multithreaded job.
|
PrintObjectTransformedInputStream |
SpooledFile.getTransformedInputStream(PrintParameterList transformOptions) |
Returns a transformed input stream that can be used to read the contents of the
spooled file.
|
String |
Command.getValidityCheckProgram() |
Returns the fully qualified integrated file system path of the program
that performs additional user-defined validity checking on the parameters
for this command.
|
String |
Command.getValidityCheckState() |
Returns the state from which the validity check program is called.
|
Object |
MemberDescription.getValue(int attribute) |
Returns the requested member attribute information object.
|
Object |
ObjectDescription.getValue(int attribute) |
Returns the value of the given attribute of this ObjectDescription.
|
String |
ObjectDescription.getValueAsString(int attribute) |
Returns the value of the given attribute of this ObjectDescription, as a String.
|
int |
SaveFile.getWaitTime() |
Returns the wait time for the save file.
|
String |
Command.getWhereAllowedToRun() |
Returns the API string for the "where allowed to run" field.
|
String |
Command.getXML() |
Retrieves the XML source for this CL command.
|
String |
Command.getXMLExtended() |
Retrieves the extended XML source for this CL command.
|
PanelGroupHelpIdentifier[] |
Command.getXMLHelpIdentifiers() |
Parses the XML source for this CL command and returns
the help identifiers.
|
String |
Command.getXMLHelpText() |
Parses the XML source for this CL command and returns
the help text.
|
String |
Command.getXMLHelpText(PanelGroup panelGroup) |
Parses the XML source for this CL command and returns
the help text.
|
String |
Command.getXMLPanelGroup() |
Parses the XML source for this CL command and returns
the name of the panel group.
|
String |
Command.getXMLProductLibrary() |
Parses the XML source for this CL command and returns
the product library.
|
static boolean |
QSYSPermission.hasObjectAuthorities(AS400 system,
String userProfileName,
String objectPath,
String[] authorityList) |
Determines if the user has the given authorities to the object on the system.
|
void |
OutputQueue.hold() |
Holds the output queue on the system.
|
void |
SpooledFile.hold(String holdType) |
Holds the spooled file.
|
boolean |
PTF.isActionPending() |
Indicates if a required action has yet to be performed to make
this PTF active.
|
boolean |
Command.isAllowedToRun(int environment) |
Indicates whether the command is allowed to run in the specified environment.
|
boolean |
Command.isAllowedToRunBatch() |
Indicates whether or not this command is allowed to run in one or more
of the batch environments:
ALLOW_BATCH_PROGRAM
ALLOW_BATCH_JOB
ALLOW_BATCH_REXX_PROCEDURE
|
boolean |
Command.isAllowedToRunInteractive() |
Indicates whether or not this command is allowed to run in one or more
of the interactive environments:
ALLOW_INTERACTIVE_PROGRAM
ALLOW_INTERACTIVE_JOB
ALLOW_INTERACTIVE_REXX_PROCEDURE
|
boolean |
PrintObjectList.isCompleted() |
Checks if a list that was opened asynchronously has completed.
|
boolean |
PTF.isConditional() |
Indicates if this PTF has a conditional relationship
with any of its dependents or requisites.
|
boolean |
PTF.isCoRequisite() |
Indicates if this PTF has a co-requisite relationship with another PTF.
|
boolean |
PTF.isDependent() |
Indicates if this PTF has a dependent relationship with another PTF.
|
boolean |
PTF.isDistRequisite() |
|
boolean |
ClusteredHashTable.isEmpty() |
Indicates if the clustered hash table contains any keys.
|
boolean |
Command.isEnabledForGUI() |
Indicates whether or not the command prompt panels are enabled for conversion
to a graphical user interface.
|
boolean |
Product.isInstalled() |
Indicates whether or not this product is installed on the system.
|
boolean |
Product.isLoadInError() |
Indicates if there is a known error for this product load.
|
boolean |
PTF.isOnOrder() |
Indicates if this PTF has been ordered.
|
boolean |
Command.isOperatingMode(int mode) |
Indicates if this command applies to the specified mode of operating environment.
|
boolean |
PTF.isPreRequisite() |
Indicates if this PTF has a pre-requisite relationship with another PTF.
|
boolean |
PTF.isReleased() |
Indicates if the PTF save file is available for distribution to other systems.
|
boolean |
PTF.isRequired() |
Indicates if this PTF is required on the system because it is a pre-requisite
for another PTF.
|
boolean |
SaveFile.isShared() |
Reports whether the open data path (ODP) for the save file is shared with other programs in the routing step.
|
boolean |
IFSFile.isSourcePhysicalFile() |
Determines if the file is an IBM i "source physical file".
|
boolean |
Product.isSupported() |
Indicates whether this product feature is currently supported.
|
boolean |
PTF.isTechRefreshPTF() |
|
boolean |
PTF.isTechRefreshRequisite() |
|
boolean |
JavaProgram.isUseAdoptedAuthority() |
Returns whether or not the used adopted authority is set.
|
static Subsystem[] |
Subsystem.listAllSubsystems(AS400 system) |
Lists all subsystems on the system.
|
SaveFileEntry[] |
SaveFile.listEntries() |
Lists the contents of the save file.
|
Product[] |
SaveFile.listProducts() |
Lists the product loads in the save file.
|
void |
MemberList.load() |
Loads all members from the specified file(s).
|
void |
ObjectList.load() |
Loads the list of objects on the system.
|
void |
SubsystemEntryList.load() |
Loads all entries from the specified subsystem.
|
void |
AS400File.lock(int lockToObtain) |
Obtains a lock on the file.
|
void |
SpooledFile.move(OutputQueue targetOutputQueue) |
Moves the spooled file to another output queue.
|
void |
SpooledFile.move(SpooledFile targetSpooledFile) |
Moves the spooled file to another output queue or to another
position on the same output queue.
|
void |
SpooledFile.moveToTop() |
Moves the spooled file to the first position on the output queue.
|
void |
AS400File.open() |
Opens the file.
|
void |
AS400File.open(int openType,
int blockingFactor,
int commitLockLevel) |
Opens the file.
|
void |
ClusteredHashTable.open() |
Opens a connection to the Clustered Hash Table server.
|
void |
PrintObjectList.openSynchronously() |
Builds the list synchronously.
|
void |
KeyedFile.positionCursor(byte[] key,
int numberOfKeyFields) |
Positions the file cursor to the first record matching the specified
key.
|
void |
KeyedFile.positionCursor(byte[] key,
int searchType,
int numberOfKeyFields) |
Positions the file cursor to the first record meeting the specified search criteria
based on key.
|
void |
KeyedFile.positionCursor(Object[] key) |
Positions the file cursor to the first record matching the specified
key.
|
void |
KeyedFile.positionCursor(Object[] key,
int searchType) |
Positions the file cursor to the first record meeting the specified search criteria
based on key.
|
void |
SequentialFile.positionCursor(int recordNumber) |
Positions the file cursor to the first record whose record number
matches the specified record number.
|
void |
KeyedFile.positionCursorAfter(byte[] key,
int numberOfKeyFields) |
Positions the file cursor to the first record after the record specified
by key.
|
void |
KeyedFile.positionCursorAfter(Object[] key) |
Positions the file cursor to the first record after the record specified
by key.
|
void |
SequentialFile.positionCursorAfter(int recordNumber) |
Positions the file cursor to the first record after the record specified
by the record number.
|
void |
AS400File.positionCursorAfterLast() |
Positions the file cursor to after the last record.
|
void |
KeyedFile.positionCursorBefore(byte[] key,
int numberOfKeyFields) |
Positions the file cursor to the first record before the record specified
by key.
|
void |
KeyedFile.positionCursorBefore(Object[] key) |
Positions the file cursor to the first record before the record specified
by key.
|
void |
SequentialFile.positionCursorBefore(int recordNumber) |
Positions the file cursor to the first record before the record specified
by the record number.
|
void |
AS400File.positionCursorBeforeFirst() |
Positions the file cursor to before the first record.
|
void |
AS400File.positionCursorToFirst() |
Positions the file cursor to the first record.
|
void |
AS400File.positionCursorToLast() |
Positions the file cursor to the last record.
|
void |
AS400File.positionCursorToNext() |
Positions the file cursor to the next record.
|
void |
AS400File.positionCursorToPrevious() |
Positions the file cursor to the previous record.
|
void |
ClusteredHashTable.put(ClusteredHashTableEntry entry) |
Put an entry in the clustered hash table identified by the connection handle.
|
Record |
AS400File.read() |
Reads the record at the current cursor position.
|
Record |
KeyedFile.read(byte[] key,
int numberOfKeyFields) |
Reads the first record with the specified key.
|
Record |
KeyedFile.read(byte[] key,
int searchType,
int numberOfKeyFields) |
Reads the first record meeting the specified search criteria based on
key.
|
Record |
KeyedFile.read(Object[] key) |
Reads the first record with the specified key.
|
Record |
KeyedFile.read(Object[] key,
int searchType) |
Reads the first record meeting the specified search criteria based on
key.
|
Record |
SequentialFile.read(int recordNumber) |
Reads the record with the specified record number.
|
Record |
KeyedFile.readAfter(byte[] key,
int numberOfKeyFields) |
Reads the first record after the record with the specified key.
|
Record |
KeyedFile.readAfter(Object[] key) |
Reads the first record after the record with the specified key.
|
Record |
SequentialFile.readAfter(int recordNumber) |
Reads the first record after the record with the specified record number.
|
abstract Record[] |
AS400File.readAll() |
Reads all the records in the file.
|
Record[] |
KeyedFile.readAll() |
Reads all the records in the file.
|
Record[] |
SequentialFile.readAll() |
Reads all the records in the file.
|
Record |
KeyedFile.readBefore(byte[] key,
int numberOfKeyFields) |
Reads the first record before the record with the specified key.
|
Record |
KeyedFile.readBefore(Object[] key) |
Reads the first record before the record with the specified key.
|
Record |
SequentialFile.readBefore(int recordNumber) |
Reads the first record before the record with the specified record number.
|
Record |
AS400File.readFirst() |
Reads the first record in the file.
|
Record |
AS400File.readLast() |
Reads the last record in the file.
|
Record |
AS400File.readNext() |
Reads the next record in the file from the current cursor position.
|
Record |
KeyedFile.readNextEqual() |
Reads the next record whose key matches the full key of the current record.
|
Record |
KeyedFile.readNextEqual(byte[] key,
int numberOfKeyFields) |
Reads the next record whose key matches the specified key.
|
Record |
KeyedFile.readNextEqual(Object[] key) |
Reads the next record whose key matches the specified key.
|
Record |
AS400File.readPrevious() |
Reads the previous record in the file from the current cursor position.
|
Record |
KeyedFile.readPreviousEqual() |
Reads the previous record whose key matches the key of the current record.
|
Record |
KeyedFile.readPreviousEqual(byte[] key,
int numberOfKeyFields) |
Reads the previous record whose key matches the specified key.
|
Record |
KeyedFile.readPreviousEqual(Object[] key) |
Reads the previous record whose key matches the specified key.
|
void |
Command.refresh() |
Refreshes the information for this Command object.
|
void |
JavaProgram.refresh() |
Refreshes all the values for this PTF by retrieving them from the system.
|
void |
JobDescription.refresh() |
Refreshes the values for all attributes of the job description.
|
void |
JobQueue.refresh() |
Refreshes the values for all attributes of the job queue.
|
void |
MemberDescription.refresh() |
Retrieves (and caches) all attributes of this member from the system.
|
void |
ObjectDescription.refresh() |
Retrieves all possible attributes of this object from the system.
|
boolean |
Product.refresh() |
Refreshes the current values and settings for this Product by retrieving all of them from the system.
|
void |
PTF.refresh() |
Refreshes all the values for this PTF by retrieving them from the system.
|
void |
SaveFile.refresh() |
Purges any cached attribute information about the save file.
|
void |
Subsystem.refresh() |
Refreshes the attributes of this Subsystem object, to reflect the current state of the subsystem on the system.
|
void |
AS400File.refreshRecordCache() |
Refreshes the record cache for this file.
|
void |
Job.release() |
Releases this job.
|
void |
OutputQueue.release() |
Releases a held output queue on the system.
|
void |
SpooledFile.release() |
Releases a held spooled file on the system.
|
void |
AS400File.releaseExplicitLocks() |
Releases all locks acquired via the lock() method.
|
void |
Subsystem.removePool(int sequenceNumber) |
Removes a storage pool from the list of pools defined for the subsystem.
|
void |
SaveFile.renameTo(String name) |
Renames the save file.
|
void |
SaveFile.restore(Product product) |
Restores a licenced program product that was saved into the save file.
|
void |
SaveFile.restore(String libraryName) |
Restores a library that was saved into the save file.
|
void |
SaveFile.restore(String libraryName,
String[] objectList,
String toLibraryName) |
Restores objects that were saved into the save file.
|
RecordFormat[] |
AS400FileRecordDescription.retrieveRecordFormat() |
Retrieves the file description for the file, and creates a RecordFormat
object for each record format, which can be used as input to the
AS400File.setRecordFormat()
method. |
void |
AS400File.rollback() |
Rolls back any transactions since the last commit/rollback boundary.
|
static void |
AS400File.rollback(AS400 system) |
Rolls back any transactions since the last commit/rollback boundary for the specified system.
|
void |
SaveFile.save(Product product) |
Saves a copy of all of the objects that make up a licenced program product, into the save file.
|
void |
SaveFile.save(String libraryName) |
Saves a library into the save file.
|
void |
SaveFile.save(String[] pathList) |
Saves files from the root file system into the save file.
|
void |
SaveFile.save(String libraryName,
String[] objectList) |
Saves objects into the save file.
|
void |
SpooledFile.sendNet(PrintParameterList sendOptions) |
Sends the spooled file to another user on the same system or to
a remote system on the network.
|
void |
SpooledFile.sendTCP(PrintParameterList sendOptions) |
Sends a spooled file to be printed on a remote system.
|
void |
SystemPool.setActivityLevel(int value) |
Sets the activity level for the pool.
|
void |
Printer.setAttributes(PrintParameterList attributes) |
Sets one or more attributes of the object.
|
void |
PrinterFile.setAttributes(PrintParameterList attributes) |
Sets one or more attributes of the object.
|
void |
SpooledFile.setAttributes(PrintParameterList attributes) |
Sets one or more attributes of the object.
|
void |
SaveFile.setDescription(String description) |
Sets the text description of the save file.
|
void |
SystemPool.setFaults(float minValue,
float perValue,
float maxValue) |
Sets the minimum faults-per-second guideline, the faults per second for each active thread,
and the maximum faults-per-second guideline for this storage pool.
|
void |
SystemPool.setMaximumFaults(float value) |
Sets the maximum faults-per-second guideline to use for this storage
pool.
|
void |
SaveFile.setMaximumNumberOfRecords(long maximumNumberOfRecords) |
Sets the capacity (maximum number of records) of the save file.
|
void |
SystemPool.setMaximumPoolSize(float value) |
Sets the maximum amount of storage to allocate to this storage pool
(as a percentage of total main storage).
|
void |
SystemPool.setMessageLogging(boolean log) |
Sets the value indicating whether messages reporting that a change was
made are written to the current job's job log and to the QHST message
log.
|
void |
SystemPool.setMinAndMaxPoolSize(float minValue,
float maxValue) |
Sets the minimum and maximum amount of storage to allocate to this storage pool
(as a percentage of total main storage).
|
void |
SystemPool.setMinimumFaults(float value) |
Sets the minimum faults-per-second guideline to use for this storage
pool.
|
void |
SystemPool.setMinimumPoolSize(float value) |
Sets the minimum amount of storage to allocate to this storage pool
(as a percentage of total main storage).
|
void |
SystemPool.setPagingOption(String value) |
Sets the value indicating whether the system dynamically adjust the
paging characteristics of the storage pool for optimum performance.
|
void |
IFSFile.setPermission(Permission permission) |
Sets the permission of the object.
|
void |
SystemPool.setPerThreadFaults(float value) |
Sets the faults per second for each active thread in this storage
pool.
|
void |
SystemPool.setPoolActivityLevel(int value) |
Deprecated.
Use setActivityLevel() instead.
|
void |
SystemPool.setPoolSize(int value) |
Deprecated.
Use setSize() instead.
|
void |
SystemPool.setPriority(int value) |
Sets the priority of this pool relative the priority of the other
storage pools.
|
void |
AS400File.setRecordFormat() |
Sets the record format to be used for this file.
|
void |
AS400File.setRecordFormat(int recordFormat) |
Sets the record format to be used for this file.
|
void |
AS400File.setRecordFormat(String recordFormat) |
Sets the record format to be used for this file.
|
void |
SaveFile.setShared(boolean shared) |
Sets whether the open data path (ODP) for the save file is shared with other programs in the routing step.
|
void |
SystemPool.setSize(int value) |
Sets the size of the system pool in kilobytes, where one kilobyte is
1024 bytes.
|
void |
SystemPool.setSizeLong(long value) |
Sets the size of the system pool in kilobytes, where one kilobyte is
1024 bytes.
|
void |
SaveFile.setWaitTime(int seconds) |
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.
|
int |
ClusteredHashTable.size() |
Return the number of entries in the clustered hash table.
|
void |
Subsystem.start() |
Starts the subsystem on the system.
|
static WriterJob |
WriterJob.start(AS400 system,
Printer printer,
PrintParameterList options,
OutputQueue outputQueue) |
Starts a writer on the system.
|
void |
AS400File.startCommitmentControl(int commitLockLevel) |
Starts commitment control on this file (for this connection).
|
static void |
AS400File.startCommitmentControl(AS400 system,
int commitLockLevel) |
Starts commitment control for the specified system.
|
void |
NativeErrorCode0100Exception.throwMappedException(Converter converter) |
Throws the corresponding toolbox exception for the current exception.
|
void |
AS400File.update(Record record) |
Updates the record at the current cursor position.
|
void |
KeyedFile.update(byte[] key,
Record record,
int numberOfKeyFields) |
Updates the record specified by key.
|
void |
KeyedFile.update(byte[] key,
Record record,
int searchType,
int numberOfKeyFields) |
Updates the first record meeting the specified search criteria based on
key.
|
void |
KeyedFile.update(Object[] key,
Record record) |
Updates the record specified by key.
|
void |
KeyedFile.update(Object[] key,
Record record,
int searchType) |
Updates the first record meeting the specified search criteria based on
key.
|
void |
PrintObject.update() |
Updates the attributes of this object by going to the system and
retrieving the latest attributes for the object.
|
void |
SequentialFile.update(int recordNumber,
Record record) |
Updates the record at the position specified by the record number.
|
void |
PrintObjectList.waitForItem(int itemNumber) |
Blocks until the number of requested items are done being built.
|
void |
PrintObjectList.waitForListToComplete() |
Blocks until the list is done being built.
|
void |
AS400File.write(Record record) |
Writes a record to the file.
|
void |
AS400File.write(Record[] records) |
Writes an array of records to the file.
|
Constructor | Description |
---|---|
Permission(AS400 as400,
String fileName) |
Constructs a Permission object.
|
Permission(AS400 as400,
String fileName,
boolean pathMayStartWithIASP) |
Constructs a Permission object.
|
Permission(AS400 as400,
String fileName,
boolean pathMayStartWithIASP,
boolean followLinks) |
Constructs a Permission object.
|
Permission(IFSFile file) |
Constructs a Permission object.
|
Permission(IFSFile file,
boolean pathMayStartWithIASP) |
Constructs a Permission object.
|
Permission(IFSFile file,
boolean pathMayStartWithIASP,
boolean followLinks) |
Constructs a Permission object.
|
SpooledFileOutputStream(AS400 system,
PrintParameterList options,
PrinterFile printerFile,
OutputQueue outputQueue) |
Constructs a SpooledFileOutputStream object.
|
Modifier and Type | Method | Description |
---|---|---|
User |
AS400Principal.getUser() |
Returns an IBM i system User object based on the
user profile name and
system associated with
the principal.
|
Modifier and Type | Method | Description |
---|---|---|
String |
CommandHelpRetriever.generateHTML(Command command) |
Generates IBM-formatted command help documentation for the specified CL command.
|
String |
CommandHelpRetriever.generateHTML(Command command,
PanelGroup panelGroup) |
Generates IBM-formatted command help documentation for the specified CL command.
|
byte[] |
CommandHelpRetriever.generateHTMLBytes(Command command,
PanelGroup panelGroup) |
Generates IBM-formatted command help documentation for the specified CL command.
|
String |
CommandHelpRetriever.generateUIM(Command command) |
Generates an IBM-formatted UIM template for the specified CL command.
|
Constructor | Description |
---|---|
VSystemStatus() |
Deprecated.
Constructs a VSystemStatus object.
|
VSystemStatus(AS400 system) |
Deprecated.
Constructs a VSystemStatus object.
|
VSystemStatus(SystemStatus systemStatus) |
Deprecated.
Constructs a VSystemStatus object.
|
VSystemStatus(VNode parent,
AS400 system) |
Deprecated.
Constructs a VSystemStatus object.
|
Copyright © 2025. All rights reserved.