com.ibm.as400.access

Class PTF

java.lang.Object

com.ibm.as400.access.PTF

public class PTF
extends java.lang.Object

Represents a Program Temporary Fix (PTF) for a licensed program product. Call refresh() to reload all of the values from the system. Individual getters will only refresh their own necessary information.

See Also:

Product.getPTFs(boolean)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_NOT_REQUIRED Constant indicating that no action is required.
static java.lang.String	ACTION_REQUIRED_CANNOT_VERIFY Constant indicating that the PTF contains activation instructions in the cover letter, but no exit program exists to verify the activation instructions were performed.
static java.lang.String	ACTION_REQUIRED_EXIT_PROGRAM Constant indicating that the PTF contains activation instructions in the cover letter.
static int	IPL_ACTION_APPLY_PERMANENT Constant indicating the PTF will be permanently applied at the next IPL.
static int	IPL_ACTION_APPLY_TEMPORARY Constant indicating the PTF will be temporarily applied at the next IPL.
static int	IPL_ACTION_NONE Constant indicating no action will occur at the next IPL.
static int	IPL_ACTION_REMOVE_PERMANENT Constant indicating the PTF will be permanently removed at the next IPL.
static int	IPL_ACTION_REMOVE_TEMPORARY Constant indicating the PTF will be temporarily removed at the next IPL.
static java.lang.String	IPL_SOURCE_A Constant indicating the system is currently operating on the A IPL source.
static java.lang.String	IPL_SOURCE_B Constant indicating the system is currently operating on the B IPL source.
static java.lang.String	IPL_SOURCE_UNKNOWN Constant indicating the current IPL source could not be determined.
static java.lang.String	PRODUCT_ID_ONLY Constant representing a product ID of *ONLY.
static java.lang.String	PRODUCT_RELEASE_ONLY Constant representing a release level of *ONLY.
static java.lang.String	PTF_TYPE_DELAYED Constant indicating that the PTF is delayed and must be applied at IPL time.
static java.lang.String	PTF_TYPE_IMMEDIATE Constant indicating that the PTF is immediate and can be applied immediately.
static java.lang.String	PTF_TYPE_UNKNOWN Constant indicating that the PTF type is not known.
static java.lang.String	RELATIONSHIP_COREQ Constant indicating that there is a co-requisite relationship between two PTFs.
static java.lang.String	RELATIONSHIP_DEPEND Constant indicating that there is a dependent (pre-requisite) relationship between two PTFs.
static java.lang.String	RELATIONSHIP_DSTREQ Constant indicating that there is a distribution requisite relationship between two PTFs.
static java.lang.String	RELATIONSHIP_NONE Constant indicating that there is no known relationship between two PTFs.
static java.lang.String	RELATIONSHIP_PREREQ Constant indicating that there is a pre-requisite relationship between two PTFs.
static java.lang.String	RELATIONSHIP_SAME Constant indicating that two PTFs are identical.
static java.lang.String	RELATIONSHIP_TRREQ Constant indicating that there is a technology refresh requisite relationship between two PTFs.
static java.lang.String	STATUS_APPLIED Constant indicating that a PTF is applied.
static java.lang.String	STATUS_APPLIED_PERMANENT Constant indicating that a PTF is permanently applied.
static java.lang.String	STATUS_DAMAGED Constant indicating that a PTF is damaged.
static java.lang.String	STATUS_LOADED Constant indicating that a PTF is loaded.
static java.lang.String	STATUS_NOT_LOADED Constant indicating that a PTF is not loaded.
static java.lang.String	STATUS_REMOVED_PERMANENT Constant indicating that a PTF is permanently removed.
static java.lang.String	STATUS_SUPERSEDED Constant indicating that a PTF is superseded.

Constructor Summary

Constructors

Constructor and Description
PTF(AS400 system, java.lang.String ptfID) Constructs a PTF object.
PTF(AS400 system, java.lang.String ptfID, java.lang.String productID, java.lang.String releaseLevel) Constructs a PTF object.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getActionRequired() Returns the action required to make this PTF active when it is applied.
java.lang.String[]	getAPARNumbers() Retrieves the list of APAR numbers that were fixed by this PTF.
PTFCoverLetter	getCoverLetter() Retrieves the cover letter for this PTF from the system.
PTFCoverLetter	getCoverLetter(java.util.Locale locale) Retrieves the cover letter for this PTF from the system based on the given locale.
PTFCoverLetter[]	getCoverLetters() Retrieves the cover letters for this PTF from the system, if they exist.
java.util.Date	getCreationDate() Returns the date and time that the PTF was created.
java.lang.String	getCurrentIPLSource() Returns the copy of Licensed Internal Code that the system is currently operating from.
PTF[]	getDependentPTFs() Retrieves the list of PTFs that are dependent upon this PTF.
PTFExitProgram[]	getExitPrograms() Retrieves the list of exit programs for this PTF.
java.lang.String	getID() Returns the ID number for this PTF.
int	getIPLAction() Returns the action to be taken on this PTF during the next IPL.
java.lang.String	getIPLRequired() Returns the type of PTF (delayed or immediate).
java.lang.String	getLICGroup() Returns the name of the Licensed Internal Code Group for this PTF.
java.lang.String	getLoadedStatus() Returns the current loaded status of this PTF.
java.lang.String	getLoadedStatusMessage(java.lang.String loadedStatus) Returns the translated description text for the specified status.
java.lang.String	getMaximumLevel() Returns the highest release level of the product on which this PTF can be installed.
java.lang.String	getMinimumLevel() Returns the lowest release level of the product on which this PTF can be installed.
java.lang.String	getOmitStatus() Return omit status for PTF getting by PTFGroup.getPTFs()
java.lang.String	getProductFeature() Returns the product feature to which this PTF applies.
java.lang.String	getProductID() Returns the product ID of this PTF.
java.lang.String	getProductOption() Returns the product option to which this PTF applies.
java.lang.String	getProductStatus() Return product status for PTF getting by PTFGroup.getPTFs()
java.lang.String	getRelationship(PTF ptf) Returns the relationship between this PTF and another PTF.
java.lang.String	getReleaseLevel() Returns the release level of this PTF.
PTF[]	getRequisitePTFs() Retrieves the list of pre- and co-requisite PTFs for this PTF.
java.lang.String	getSaveFile() Returns the full pathname of the save file for this PTF, if one exists.
int	getServerIPLRequired() Indicates whether a server IPL must be performed in order to activate the changes for the PTF.
java.util.Date	getStatusDate() Returns the date and time the PTF status last changed.
java.lang.String	getSupersedingPTF() Returns the PTF ID of the PTF that supersedes this PTF.
java.lang.String[]	getSymptomStrings() Returns the list of symptom strings for the problems fixed by this PTF.
java.lang.String	getTargetRelease() Returns the earliest release of the operating system on which you can load and apply this PTF.
boolean	getTechRefreshPTF() Deprecated. Use isTechRefreshPTF() instead.
boolean	isActionPending() Indicates if a required action has yet to be performed to make this PTF active.
boolean	isConditional() Indicates if this PTF has a conditional relationship with any of its dependents or requisites.
boolean	isCoRequisite() Indicates if this PTF has a co-requisite relationship with another PTF.
boolean	isDependent() Indicates if this PTF has a dependent relationship with another PTF.
boolean	isDistRequisite()
boolean	isOnOrder() Indicates if this PTF has been ordered.
boolean	isPreRequisite() Indicates if this PTF has a pre-requisite relationship with another PTF.
boolean	isReleased() Indicates if the PTF save file is available for distribution to other systems.
boolean	isRequired() Indicates if this PTF is required on the system because it is a pre-requisite for another PTF.
boolean	isTechRefreshPTF()
boolean	isTechRefreshRequisite()
void	refresh() Refreshes all the values for this PTF by retrieving them from the system.
java.lang.String	toString() Returns a String representation of this PTF in the format "PTF ID/release level/product ID".

Methods inherited from class java.lang.Object

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

Field Detail

ACTION_NOT_REQUIRED

public static final java.lang.String ACTION_NOT_REQUIRED

Constant indicating that no action is required.

See Also:

Constant Field Values

ACTION_REQUIRED_EXIT_PROGRAM

public static final java.lang.String ACTION_REQUIRED_EXIT_PROGRAM

Constant indicating that the PTF contains activation instructions in the cover letter. The PTF has an exit program to update the status of the PTF after the activation instructions have been performed.

See Also:

Constant Field Values

ACTION_REQUIRED_CANNOT_VERIFY

public static final java.lang.String ACTION_REQUIRED_CANNOT_VERIFY

Constant indicating that the PTF contains activation instructions in the cover letter, but no exit program exists to verify the activation instructions were performed.

See Also:

Constant Field Values

IPL_ACTION_NONE

public static final int IPL_ACTION_NONE

Constant indicating no action will occur at the next IPL.

See Also:

Constant Field Values

IPL_ACTION_APPLY_TEMPORARY

public static final int IPL_ACTION_APPLY_TEMPORARY

Constant indicating the PTF will be temporarily applied at the next IPL.

See Also:

Constant Field Values

IPL_ACTION_REMOVE_TEMPORARY

public static final int IPL_ACTION_REMOVE_TEMPORARY

Constant indicating the PTF will be temporarily removed at the next IPL.

See Also:

Constant Field Values

IPL_ACTION_APPLY_PERMANENT

public static final int IPL_ACTION_APPLY_PERMANENT

Constant indicating the PTF will be permanently applied at the next IPL.

See Also:

Constant Field Values

IPL_ACTION_REMOVE_PERMANENT

public static final int IPL_ACTION_REMOVE_PERMANENT

Constant indicating the PTF will be permanently removed at the next IPL.

See Also:

Constant Field Values

IPL_SOURCE_A

public static final java.lang.String IPL_SOURCE_A

Constant indicating the system is currently operating on the A IPL source.

See Also:

Constant Field Values

IPL_SOURCE_B

public static final java.lang.String IPL_SOURCE_B

Constant indicating the system is currently operating on the B IPL source.

See Also:

Constant Field Values

IPL_SOURCE_UNKNOWN

public static final java.lang.String IPL_SOURCE_UNKNOWN

Constant indicating the current IPL source could not be determined.

See Also:

Constant Field Values

PRODUCT_ID_ONLY

public static final java.lang.String PRODUCT_ID_ONLY

Constant representing a product ID of *ONLY.

See Also:

Constant Field Values

PRODUCT_RELEASE_ONLY

public static final java.lang.String PRODUCT_RELEASE_ONLY

Constant representing a release level of *ONLY.

See Also:

Constant Field Values

PTF_TYPE_DELAYED

public static final java.lang.String PTF_TYPE_DELAYED

Constant indicating that the PTF is delayed and must be applied at IPL time.

See Also:

Constant Field Values

PTF_TYPE_IMMEDIATE

public static final java.lang.String PTF_TYPE_IMMEDIATE

Constant indicating that the PTF is immediate and can be applied immediately. No IPL is needed.

See Also:

Constant Field Values

PTF_TYPE_UNKNOWN

public static final java.lang.String PTF_TYPE_UNKNOWN

Constant indicating that the PTF type is not known.

See Also:

Constant Field Values

RELATIONSHIP_COREQ

public static final java.lang.String RELATIONSHIP_COREQ

Constant indicating that there is a co-requisite relationship between two PTFs.

See Also:

getRelationship(com.ibm.as400.access.PTF), Constant Field Values

RELATIONSHIP_DEPEND

public static final java.lang.String RELATIONSHIP_DEPEND

Constant indicating that there is a dependent (pre-requisite) relationship between two PTFs.

See Also:

getRelationship(com.ibm.as400.access.PTF), Constant Field Values

RELATIONSHIP_NONE

public static final java.lang.String RELATIONSHIP_NONE

Constant indicating that there is no known relationship between two PTFs.

See Also:

getRelationship(com.ibm.as400.access.PTF), Constant Field Values

RELATIONSHIP_PREREQ

public static final java.lang.String RELATIONSHIP_PREREQ

Constant indicating that there is a pre-requisite relationship between two PTFs.

See Also:

getRelationship(com.ibm.as400.access.PTF), Constant Field Values

RELATIONSHIP_SAME

public static final java.lang.String RELATIONSHIP_SAME

Constant indicating that two PTFs are identical.

See Also:

getRelationship(com.ibm.as400.access.PTF), Constant Field Values

STATUS_NOT_LOADED

public static final java.lang.String STATUS_NOT_LOADED

Constant indicating that a PTF is not loaded.

See Also:

Constant Field Values

STATUS_LOADED

public static final java.lang.String STATUS_LOADED

Constant indicating that a PTF is loaded.

See Also:

Constant Field Values

STATUS_APPLIED

public static final java.lang.String STATUS_APPLIED

Constant indicating that a PTF is applied.

See Also:

Constant Field Values

STATUS_APPLIED_PERMANENT

public static final java.lang.String STATUS_APPLIED_PERMANENT

Constant indicating that a PTF is permanently applied.

See Also:

Constant Field Values

STATUS_REMOVED_PERMANENT

public static final java.lang.String STATUS_REMOVED_PERMANENT

Constant indicating that a PTF is permanently removed.

See Also:

Constant Field Values

STATUS_DAMAGED

public static final java.lang.String STATUS_DAMAGED

Constant indicating that a PTF is damaged.

See Also:

Constant Field Values

STATUS_SUPERSEDED

public static final java.lang.String STATUS_SUPERSEDED

Constant indicating that a PTF is superseded.

See Also:

Constant Field Values

RELATIONSHIP_TRREQ

public static final java.lang.String RELATIONSHIP_TRREQ

Constant indicating that there is a technology refresh requisite relationship between two PTFs.

See Also:

getRelationship(com.ibm.as400.access.PTF), Constant Field Values

RELATIONSHIP_DSTREQ

public static final java.lang.String RELATIONSHIP_DSTREQ

Constant indicating that there is a distribution requisite relationship between two PTFs.

See Also:

getRelationship(com.ibm.as400.access.PTF), Constant Field Values

Constructor Detail

PTF

public PTF(AS400 system,
   java.lang.String ptfID)

Constructs a PTF object. The product ID defaults to PRODUCT_ID_ONLY and the release level defaults to PRODUCT_RELEASE_ONLY.

Parameters:

system - The system.

ptfID - The PTF ID. Example: "SF64578"

PTF

public PTF(AS400 system,
   java.lang.String ptfID,
   java.lang.String productID,
   java.lang.String releaseLevel)

Constructs a PTF object.

Parameters:

system - The system.

ptfID - The PTF ID. Example: "SF64578"

productID - The product ID (for example: "5722JC1"). This value must either be PRODUCT_ID_ONLY or a valid product ID.

releaseLevel - The PTF release level (for example: "V5R1M0"). This value must either be PRODUCT_RELEASE_ONLY or a valid release level.

Method Detail

getProductStatus

public java.lang.String getProductStatus()

Return product status for PTF getting by PTFGroup.getPTFs()

Returns:

product status

getOmitStatus

public java.lang.String getOmitStatus()

Return omit status for PTF getting by PTFGroup.getPTFs()

Returns:

omit status as a string

getActionRequired

public java.lang.String getActionRequired()
                                   throws AS400Exception,
                                          AS400SecurityException,
                                          ErrorCompletingRequestException,
                                          java.lang.InterruptedException,
                                          java.io.IOException,
                                          ObjectDoesNotExistException

Returns the action required to make this PTF active when it is applied. See the cover letter to determine what action needs to be taken. Possible return values are:

• ACTION_NOT_REQUIRED
• ACTION_REQUIRED_EXIT_PROGRAM
• ACTION_REQUIRED_CANNOT_VERIFY

Returns:

The action required.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getAPARNumbers

public java.lang.String[] getAPARNumbers()
                                  throws AS400Exception,
                                         AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException

Retrieves the list of APAR numbers that were fixed by this PTF.

Returns:

The APAR numbers.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

See Also:

getSymptomStrings()

getCoverLetter

public PTFCoverLetter getCoverLetter()
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException

Retrieves the cover letter for this PTF from the system. The cover letter returned is for the default NLV for the system. If there are no cover letters, this method returns null.

Returns:

The cover letter.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getCoverLetter

public PTFCoverLetter getCoverLetter(java.util.Locale locale)
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException

Retrieves the cover letter for this PTF from the system based on the given locale. The cover letter returned is for the NLV that corresponds to the given locale. If there is no cover letter that corresponds to the determined NLV, the first one retrieved from the system is returned. If there are no cover letters, null is returned.

Parameters:

locale - The locale.

Returns:

The cover letter.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getCoverLetters

public PTFCoverLetter[] getCoverLetters()
                                 throws AS400Exception,
                                        AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException

Retrieves the cover letters for this PTF from the system, if they exist. Each cover letter is for its own national language version (NLV).

Returns:

The array of cover letters. If there are no cover letters, an array of size 0 is returned.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getCurrentIPLSource

public java.lang.String getCurrentIPLSource()
                                     throws AS400Exception,
                                            AS400SecurityException,
                                            ErrorCompletingRequestException,
                                            java.lang.InterruptedException,
                                            java.io.IOException,
                                            ObjectDoesNotExistException

Returns the copy of Licensed Internal Code that the system is currently operating from. The previous IPL of the system used this copy of Licensed Internal Code. Possible values are:

• IPL_SOURCE_A
• IPL_SOURCE_B
• IPL_SOURCE_UNKNOWN

Returns:

The current IPL source.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getDependentPTFs

public PTF[] getDependentPTFs()
                       throws AS400Exception,
                              AS400SecurityException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException,
                              java.io.IOException,
                              ObjectDoesNotExistException

Retrieves the list of PTFs that are dependent upon this PTF. If there are no dependent PTFs, an array of size 0 will be returned.

Returns:

The array of dependent PTFs.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

See Also:

getRequisitePTFs(), getSupersedingPTF()

getExitPrograms

public PTFExitProgram[] getExitPrograms()
                                 throws AS400Exception,
                                        AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException

Retrieves the list of exit programs for this PTF.

Returns:

The array of exit programs.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getID

public java.lang.String getID()

Returns the ID number for this PTF.

Returns:

The PTF ID. Example: "SF64578"

getIPLAction

public int getIPLAction()
                 throws AS400Exception,
                        AS400SecurityException,
                        ErrorCompletingRequestException,
                        java.lang.InterruptedException,
                        java.io.IOException,
                        ObjectDoesNotExistException

Returns the action to be taken on this PTF during the next IPL. Possible values are:

• IPL_ACTION_NONE
• IPL_ACTION_APPLY_TEMPORARY
• IPL_ACTION_REMOVE_TEMPORARY
• IPL_ACTION_APPLY_PERMANENT
• IPL_ACTION_REMOVE_PERMANENT

Returns:

The IPL action.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getIPLRequired

public java.lang.String getIPLRequired()
                                throws AS400Exception,
                                       AS400SecurityException,
                                       ErrorCompletingRequestException,
                                       java.lang.InterruptedException,
                                       java.io.IOException,
                                       ObjectDoesNotExistException

Returns the type of PTF (delayed or immediate). Possible values are:

• PTF_TYPE_DELAYED
• PTF_TYPE_IMMEDIATE
• PTF_TYPE_UNKNOWN

Returns:

The type of PTF. This indicates if an IPL is required to apply the PTF.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getLICGroup

public java.lang.String getLICGroup()
                             throws AS400Exception,
                                    AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    java.lang.InterruptedException,
                                    java.io.IOException,
                                    ObjectDoesNotExistException

Returns the name of the Licensed Internal Code Group for this PTF. If the name of the group is not available or if the PTF is not a Licensed Internal Code fix, this method returns "".

Returns:

The Licensed Interanl Code Group name.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getLoadedStatus

public java.lang.String getLoadedStatus()
                                 throws AS400Exception,
                                        AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException

Returns the current loaded status of this PTF. See the getLoadedStatusMessage() method for the translated description text of the loaded status. Possible values are:

• STATUS_NOT_LOADED
• STATUS_LOADED
• STATUS_APPLIED
• STATUS_APPLED_PERMANENT
• STATUS_REMOVED_PERMANENT
• STATUS_DAMAGED
• STATUS_SUPERSEDED

Returns:

The loaded status.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

See Also:

getLoadedStatusMessage(java.lang.String)

getLoadedStatusMessage

public java.lang.String getLoadedStatusMessage(java.lang.String loadedStatus)
                                        throws AS400Exception,
                                               AS400SecurityException,
                                               ErrorCompletingRequestException,
                                               java.lang.InterruptedException,
                                               java.io.IOException,
                                               ObjectDoesNotExistException

Returns the translated description text for the specified status. The text is retrieved from the CPX3501 message on the system.

Parameters:

loadedStatus - The loaded status. See getLoadedStatus() for the list of valid values.

Returns:

The status message, or "" if the loaded status was not valid.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getMaximumLevel

public java.lang.String getMaximumLevel()
                                 throws AS400Exception,
                                        AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException

Returns the highest release level of the product on which this PTF can be installed. If the minimum and maximum levels are the same, this PTF can only be installed on one level of the product. The level can be "AA" through "99", or blank if the product has no level.

Returns:

The release level.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

See Also:

getMinimumLevel()

getMinimumLevel

public java.lang.String getMinimumLevel()
                                 throws AS400Exception,
                                        AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException

Returns the lowest release level of the product on which this PTF can be installed. If the minimum and maximum levels are the same, this PTF can only be installed on one level of the product. The level can be "AA" through "99", or blank if the product has no level.

Returns:

The release level.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

See Also:

getMaximumLevel()

getProductFeature

public java.lang.String getProductFeature()
                                   throws AS400Exception,
                                          AS400SecurityException,
                                          ErrorCompletingRequestException,
                                          java.lang.InterruptedException,
                                          java.io.IOException,
                                          ObjectDoesNotExistException

Returns the product feature to which this PTF applies. This value will be blank if the feature cannot be determined (as in the case of a dependent or requisite PTF).

Returns:

The product feature.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getProductID

public java.lang.String getProductID()
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     java.lang.InterruptedException,
                                     java.io.IOException,
                                     ObjectDoesNotExistException

Returns the product ID of this PTF. For example: "5722JC1" If this value was initially set to PRODUCT_ID_ONLY, it will be overwritten with the value returned from the system after the values have been refreshed.

Returns:

The product ID.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getProductOption

public java.lang.String getProductOption()
                                  throws AS400Exception,
                                         AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException

Returns the product option to which this PTF applies. This value will be blank if the option cannot be determined (as in the case of a dependent or requisite PTF).

Returns:

The product option.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getRelationship

public java.lang.String getRelationship(PTF ptf)
                                 throws AS400Exception,
                                        AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException

Returns the relationship between this PTF and another PTF.

Parameters:

ptf - The PTF to compare.

Returns:

The relationship between the two PTFs. Possible values are:

• RELATIONSHIP_PREREQ - If this PTF is a pre-requisite of the specified PTF.
• RELATIONSHIP_COREQ - If this PTF is a co-requisite of the specified PTF.
• RELATIONSHIP_DEPEND - If the specified PTF is a pre-requisite of this PTF.
• RELATIONSHIP_SAME - If this PTF is identical to the specified PTF.
• RELATIONSHIP_NONE - If there is no known relationship.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getReleaseLevel

public java.lang.String getReleaseLevel()
                                 throws AS400Exception,
                                        AS400SecurityException,
                                        ErrorCompletingRequestException,
                                        java.lang.InterruptedException,
                                        java.io.IOException,
                                        ObjectDoesNotExistException

Returns the release level of this PTF. If this value was initially set to PRODUCT_RELEASE_ONLY, it will be overwritten with the value returned from the system after the values have been refreshed.

Returns:

The release level. Example: "V5R1M0"

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getRequisitePTFs

public PTF[] getRequisitePTFs()
                       throws AS400Exception,
                              AS400SecurityException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException,
                              java.io.IOException,
                              ObjectDoesNotExistException

Retrieves the list of pre- and co-requisite PTFs for this PTF. To determine whether the PTFs returned by this method are co-requisites or pre-requisites with this PTF object, call their respective isCoRequisite() and isPreRequisite() methods.

Returns:

The list of PTFs.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getSaveFile

public java.lang.String getSaveFile()
                             throws AS400Exception,
                                    AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    java.lang.InterruptedException,
                                    java.io.IOException,
                                    ObjectDoesNotExistException

Returns the full pathname of the save file for this PTF, if one exists.

Returns:

The save file, or null if this PTF has no save file on the system.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getStatusDate

public java.util.Date getStatusDate()
                             throws AS400Exception,
                                    AS400SecurityException,
                                    ErrorCompletingRequestException,
                                    java.lang.InterruptedException,
                                    java.io.IOException,
                                    ObjectDoesNotExistException

Returns the date and time the PTF status last changed. If the status date and time are not available, null is returned.

Returns:

The status date.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getSupersedingPTF

public java.lang.String getSupersedingPTF()
                                   throws AS400Exception,
                                          AS400SecurityException,
                                          ErrorCompletingRequestException,
                                          java.lang.InterruptedException,
                                          java.io.IOException,
                                          ObjectDoesNotExistException

Returns the PTF ID of the PTF that supersedes this PTF. This will be "" if there is no superseding PTF, or if the superseding PTF is not known.

Returns:

The PTF ID.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

See Also:

getDependentPTFs(), getRequisitePTFs()

getSymptomStrings

public java.lang.String[] getSymptomStrings()
                                     throws AS400Exception,
                                            AS400SecurityException,
                                            ErrorCompletingRequestException,
                                            java.lang.InterruptedException,
                                            java.io.IOException,
                                            ObjectDoesNotExistException

Returns the list of symptom strings for the problems fixed by this PTF.

Returns:

The symptom strings.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

See Also:

getAPARNumbers()

getTargetRelease

public java.lang.String getTargetRelease()
                                  throws AS400Exception,
                                         AS400SecurityException,
                                         ErrorCompletingRequestException,
                                         java.lang.InterruptedException,
                                         java.io.IOException,
                                         ObjectDoesNotExistException

Returns the earliest release of the operating system on which you can load and apply this PTF.

Returns:

The target release. Example: "V4R5M0"

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getCreationDate

public java.util.Date getCreationDate()
                               throws AS400Exception,
                                      AS400SecurityException,
                                      ErrorCompletingRequestException,
                                      java.lang.InterruptedException,
                                      java.io.IOException,
                                      ObjectDoesNotExistException

Returns the date and time that the PTF was created. If the creation date and time cannot be determined, null is returned.

NOTE: This method is not supported when running to OS/400 V5R2 or earlier releases.

Returns:

The date and time that the PTF was created, or null if not determined or system is pre-V5R3.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

getServerIPLRequired

public int getServerIPLRequired()
                         throws AS400Exception,
                                AS400SecurityException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException

Indicates whether a server IPL must be performed in order to activate the changes for the PTF.

NOTE: This method is not supported when running to OS/400 V5R2 or earlier releases.

Returns:

Whether a server IPL must be performed. The possible values are:

• 0 No server IPL is required to activate the changes for the PTF.
• 1 A server IPL must be performed using the T server IPL source in order to activate the changes for the PTF.
• 2 A server IPL must be performed using the P server IPL source in order to activate the changes for the PTF.
• -1 The value of the "IPL required" property cannot be determined, or system is pre-V5R3.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

isActionPending

public boolean isActionPending()
                        throws AS400Exception,
                               AS400SecurityException,
                               ErrorCompletingRequestException,
                               java.lang.InterruptedException,
                               java.io.IOException,
                               ObjectDoesNotExistException

Indicates if a required action has yet to be performed to make this PTF active. If true, check the activation instructions in the cover letter to determine what the action is.

Returns:

true if a required action needs to occur for this PTF to be active; false if no required actions are pending for this PTF.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

See Also:

getActionRequired(), getCoverLetters()

isConditional

public boolean isConditional()
                      throws AS400Exception,
                             AS400SecurityException,
                             ErrorCompletingRequestException,
                             java.lang.InterruptedException,
                             java.io.IOException,
                             ObjectDoesNotExistException

Indicates if this PTF has a conditional relationship with any of its dependents or requisites. This determines whether it is necessary to check the system for the presence of software that is described by this product ID, release level, option, and feature.

Returns:

true if the requisite PTF is required by this PTF only on systems that contain the software described in the other fields; false if the requisite PTF is required by this PTF on all systems that can use this PTF.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

isCoRequisite

public boolean isCoRequisite()
                      throws AS400Exception,
                             AS400SecurityException,
                             ErrorCompletingRequestException,
                             java.lang.InterruptedException,
                             java.io.IOException,
                             ObjectDoesNotExistException

Indicates if this PTF has a co-requisite relationship with another PTF.

If this PTF object was returned by a call to getRequisitePTFs() or getDependentPTFs(), then this method indicates if this PTF has a co-requisite relationship with the PTF of which it is a requisite or dependent.

If this PTF object was constructed otherwise, then this method indicates if this PTF has a known co-requisite relationship with at least one other PTF on the system. This is accomplished by checking the list of known dependent and requisite PTFs for this PTF.

Returns:

true if this PTF is a co-requisite, false otherwise.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

See Also:

getDependentPTFs(), getRequisitePTFs(), isDependent(), isPreRequisite()

isDependent

public boolean isDependent()
                    throws AS400Exception,
                           AS400SecurityException,
                           ErrorCompletingRequestException,
                           java.lang.InterruptedException,
                           java.io.IOException,
                           ObjectDoesNotExistException

Indicates if this PTF has a dependent relationship with another PTF.

If this PTF object was returned by a call to getDependentPTFs(), then this method indicates if the PTF that generated this PTF object is a pre-requisite of this PTF object.

If this PTF object was constructed otherwise, then this method indicates if this PTF is a known dependent of at least one other PTF on the system.

Returns:

true if this PTF is dependent on another PTF (that is, another PTF is a pre-requisite of this PTF), false otherwise.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

See Also:

getDependentPTFs(), getRequisitePTFs(), isCoRequisite(), isPreRequisite()

isOnOrder

public boolean isOnOrder()
                  throws AS400Exception,
                         AS400SecurityException,
                         ErrorCompletingRequestException,
                         java.lang.InterruptedException,
                         java.io.IOException,
                         ObjectDoesNotExistException

Indicates if this PTF has been ordered.

Returns:

true if the PTF has been ordered; false if it has not been ordered or has already been received.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

isPreRequisite

public boolean isPreRequisite()
                       throws AS400Exception,
                              AS400SecurityException,
                              ErrorCompletingRequestException,
                              java.lang.InterruptedException,
                              java.io.IOException,
                              ObjectDoesNotExistException

Indicates if this PTF has a pre-requisite relationship with another PTF.

If this PTF object was returned by a call to getRequisitePTFs(), then this method indicates if this PTF is a pre-requisite for the PTF object that generated this PTF.

If this PTF object was constructed otherwise, then this method indicates if this PTF is a known pre-requisite of at least one other PTF on the system.

Returns:

true if this PTF is a pre-requisite of another PTF, false otherwise.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

See Also:

getDependentPTFs(), getRequisitePTFs(), isCoRequisite(), isDependent()

isReleased

public boolean isReleased()
                   throws AS400Exception,
                          AS400SecurityException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException

Indicates if the PTF save file is available for distribution to other systems. This is true only when the System Manager licensed product is on the system and the product is supported. The save file status should also be checked.

Returns:

true if the PTF save file is released and can be distributed; false if the save file cannot be distributed.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

See Also:

getSaveFile()

isRequired

public boolean isRequired()
                   throws AS400Exception,
                          AS400SecurityException,
                          ErrorCompletingRequestException,
                          java.lang.InterruptedException,
                          java.io.IOException,
                          ObjectDoesNotExistException

Indicates if this PTF is required on the system because it is a pre-requisite for another PTF.

Returns:

true if this PTF is required on the system, false if it is not required.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

refresh

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

Refreshes all the values for this PTF by retrieving them from the system.

Throws:

AS400Exception - If an error occurs.

AS400SecurityException - If a security or authority error occurs.

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

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

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

ObjectDoesNotExistException - If the object does not exist.

toString

public java.lang.String toString()

Returns a String representation of this PTF in the format "PTF ID/release level/product ID".

Overrides:

toString in class java.lang.Object

Returns:

The String representing this PTF.

getTechRefreshPTF

public boolean getTechRefreshPTF()
                          throws AS400Exception,
                                 AS400SecurityException,
                                 ErrorCompletingRequestException,
                                 java.lang.InterruptedException,
                                 java.io.IOException,
                                 ObjectDoesNotExistException

Deprecated. Use isTechRefreshPTF() instead.

Whether the PTF is a technology refresh PTF. A technology refresh PTF is used to deliver a significant amount of new function between major releases.

Returns:

Whether the PTF is a technology refresh PTF, true or false The possible values are:

• false The PTF is not a technology refresh PTF.
• true The PTF is a technology refresh PTF.

Throws:

AS400Exception

AS400SecurityException

ErrorCompletingRequestException

java.lang.InterruptedException

java.io.IOException

ObjectDoesNotExistException

isTechRefreshPTF

public boolean isTechRefreshPTF()
                         throws AS400Exception,
                                AS400SecurityException,
                                ErrorCompletingRequestException,
                                java.lang.InterruptedException,
                                java.io.IOException,
                                ObjectDoesNotExistException

Throws:

AS400Exception

AS400SecurityException

ErrorCompletingRequestException

java.lang.InterruptedException

java.io.IOException

ObjectDoesNotExistException

isDistRequisite

public boolean isDistRequisite()
                        throws AS400Exception,
                               AS400SecurityException,
                               ErrorCompletingRequestException,
                               java.lang.InterruptedException,
                               java.io.IOException,
                               ObjectDoesNotExistException

Throws:

AS400Exception

AS400SecurityException

ErrorCompletingRequestException

java.lang.InterruptedException

java.io.IOException

ObjectDoesNotExistException

isTechRefreshRequisite

public boolean isTechRefreshRequisite()
                               throws AS400Exception,
                                      AS400SecurityException,
                                      ErrorCompletingRequestException,
                                      java.lang.InterruptedException,
                                      java.io.IOException,
                                      ObjectDoesNotExistException

Throws:

AS400Exception

AS400SecurityException

ErrorCompletingRequestException

java.lang.InterruptedException

java.io.IOException

ObjectDoesNotExistException