com.ibm.as400.access

Class PTFGroup

java.lang.Object

com.ibm.as400.access.PTFGroup

public class PTFGroup
extends java.lang.Object

Lists information for a specific PTF group on a system. Specifically you can retrieve a list of the related PTF groups, and a list of PTFs.

Field Summary

Fields

Modifier and Type	Field and Description
static int	PTF_GROUP_STATUS_APPLY_AT_NEXT_IPL Constant indicating the PTF group will be applied at next IPL.
static int	PTF_GROUP_STATUS_ERROR Constant indicating the PTF group information is in error.
static int	PTF_GROUP_STATUS_INSTALLED Constant indicating the PTF group is installed.
static int	PTF_GROUP_STATUS_NOT_APPLICABLE Constant indicating the PTF group status is "not applicable".
static int	PTF_GROUP_STATUS_NOT_FOUND Constant indicating the PTF group is not found on the system.
static int	PTF_GROUP_STATUS_NOT_INSTALLED Constant indicating the PTF group is not installed.
static int	PTF_GROUP_STATUS_ON_ORDER Constant indicating the PTF group is on order.
static int	PTF_GROUP_STATUS_RELATED_GROUP Constant indicating the PTF group is a related group.
static int	PTF_GROUP_STATUS_SUPPORTED_ONLY Constant indicating the PTF group status is "supported only".
static int	PTF_GROUP_STATUS_UNKNOWN Constant indicating the PTF group status is unknown.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	areRelatedPTFGroupsIncluded() Indicates if information from all related PTF groups are included when the list of PTFs or related PTF groups are returned.
java.lang.String	getPTFGroupDescription() Returns the description for the PTF group.
int	getPTFGroupLevel() Returns the PTF group level.
java.lang.String	getPTFGroupName() Returns the PTF group name.
int	getPTFGroupStatus() Indicates the overall status of the PTF group on this system.
PTF[]	getPTFs()
PTFGroup[]	getRelatedPTFGroups() Returns a list of related PTF groups.
AS400	getSystem() Returns the system.
java.lang.String	getTargetRelease()
void	includeRelatedPTFGroups(boolean value) Specifies whether information from all related PTF groups should be included when the list of PTFs or related PTF groups are returned.

Methods inherited from class java.lang.Object

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

Field Detail

PTF_GROUP_STATUS_UNKNOWN

public static final int PTF_GROUP_STATUS_UNKNOWN

Constant indicating the PTF group status is unknown. The PTF group status cannot be resolved because a related PTF group is either not found on the system or is in error.

See Also:

Constant Field Values

PTF_GROUP_STATUS_NOT_APPLICABLE

public static final int PTF_GROUP_STATUS_NOT_APPLICABLE

Constant indicating the PTF group status is "not applicable". All PTFs in the PTF group and related PTF groups are for products that are not installed or supported on this system.

See Also:

Constant Field Values

PTF_GROUP_STATUS_SUPPORTED_ONLY

public static final int PTF_GROUP_STATUS_SUPPORTED_ONLY

Constant indicating the PTF group status is "supported only". There are no PTFs in the PTF group or related PTF groups that are for installed products on this system. There is at least one PTF that is for a product, release, option, and load identifier that is supported on this system.

See Also:

Constant Field Values

PTF_GROUP_STATUS_NOT_INSTALLED

public static final int PTF_GROUP_STATUS_NOT_INSTALLED

Constant indicating the PTF group is not installed. There is at least one PTF that is for an installed product on this system, and not all the PTFs or their superseding PTFs are temporarily or permanently applied.

See Also:

Constant Field Values

PTF_GROUP_STATUS_INSTALLED

public static final int PTF_GROUP_STATUS_INSTALLED

Constant indicating the PTF group is installed. All PTFs for products that are installed on this system are temporarily or permanently applied. If a PTF is superseded, a superseding PTF is either temporarily or permanently applied.

See Also:

Constant Field Values

PTF_GROUP_STATUS_ERROR

public static final int PTF_GROUP_STATUS_ERROR

Constant indicating the PTF group information is in error. Either delete the PTF group or replace the PTF group information that is currently on the system.

See Also:

Constant Field Values

PTF_GROUP_STATUS_NOT_FOUND

public static final int PTF_GROUP_STATUS_NOT_FOUND

Constant indicating the PTF group is not found on the system. This status will only be returned when using format GRPR0500.

See Also:

Constant Field Values

PTF_GROUP_STATUS_APPLY_AT_NEXT_IPL

public static final int PTF_GROUP_STATUS_APPLY_AT_NEXT_IPL

Constant indicating the PTF group will be applied at next IPL. All PTFs for the installed products on the system are either set to be applied at the next IPL or are already temporarily or permanently applied.

See Also:

Constant Field Values

PTF_GROUP_STATUS_RELATED_GROUP

public static final int PTF_GROUP_STATUS_RELATED_GROUP

Constant indicating the PTF group is a related group. The PTF group does not have any PTFs for products installed or supported on the system. However, it is identified in another PTF group as a related PTF group. Deleting a PTF group in this status will cause the other PTF group to have a status of PTF_GROUP_STATUS_UNKNOWN.

See Also:

Constant Field Values

PTF_GROUP_STATUS_ON_ORDER

public static final int PTF_GROUP_STATUS_ON_ORDER

Constant indicating the PTF group is on order. There is at least one PTF in the group that is on order and has not yet been installed on the system. It will be delivered on either physical or virtual media.

See Also:

Constant Field Values

Method Detail

getSystem

public AS400 getSystem()

Returns the system.

Returns:

The system.

getRelatedPTFGroups

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

Returns a list of related PTF groups.

Returns:

array of PTFGroups

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.

getPTFGroupDescription

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

Returns the description for the PTF group.

Returns:

the description

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.

getPTFGroupName

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

Returns the PTF group name.

Returns:

the 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.

getPTFGroupLevel

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

Returns the PTF group level.

Returns:

the PTF group level, or 0 if the group level cannot be determined.

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.

getPTFGroupStatus

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

Indicates the overall status of the PTF group on this system.

Returns:

the PTF group status. Possible Values are:

• PTF_GROUP_STATUS_UNKNOWN
• PTF_GROUP_STATUS_NOT_APPLICABLE
• PTF_GROUP_STATUS_SUPPORTED_ONLY
• PTF_GROUP_STATUS_NOT_INSTALLED
• PTF_GROUP_STATUS_INSTALLED
• PTF_GROUP_STATUS_ERROR
• PTF_GROUP_STATUS_NOT_FOUND
• PTF_GROUP_STATUS_APPLY_AT_NEXT_IPL
• PTF_GROUP_STATUS_RELATED_GROUP
• PTF_GROUP_STATUS_ON_ORDER

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.

getTargetRelease

public java.lang.String getTargetRelease()

includeRelatedPTFGroups

public void includeRelatedPTFGroups(boolean value)

Specifies whether information from all related PTF groups should be included when the list of PTFs or related PTF groups are returned. By default the information is not included.

Parameters:

value - true if information from all related PTF groups should be included, false otherwise.

areRelatedPTFGroupsIncluded

public boolean areRelatedPTFGroupsIncluded()

Indicates if information from all related PTF groups are included when the list of PTFs or related PTF groups are returned.

Returns:

true if information from all related PTF groups is included, false otherwise.

getPTFs

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

Throws:

AS400Exception

AS400SecurityException

ErrorCompletingRequestException

java.lang.InterruptedException

java.io.IOException

ObjectDoesNotExistException