com.ibm.as400.access
Class PTFGroup

java.lang.Object
  extended bycom.ibm.as400.access.PTFGroup

public class PTFGroup
extends 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
static int PTF_GROUP_STATUS_ERROR
          Constant indicating the PTF group information is in error.
static int PTF_GROUP_STATUS_INSTALLED
          Constant indicating all PTFs for products that are installed on this system are temporarily or permanently applied.
static int PTF_GROUP_STATUS_NOT_APPLICABLE
          Constant indicating all PTFs in the PTF group and related PTF groups are for products that are not installed or supported on this system.
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 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.
static int PTF_GROUP_STATUS_SUPPORTED_ONLY
          Constant indicating there are no PTFs in the PTF group or related PTF groups that are for installed products on this system.
static int PTF_GROUP_STATUS_UNKNOWN
          Constant indicating the PTF Group status cannong be resolved because a related PTF group is either not found on the system or is in error.
 
Method Summary
 boolean areRelatedPTFGroupsIncluded()
          Indicates if information from all related PTF groups are included when the list of PTFs or related PTF groups are returned.
 String getPTFGroupDescription()
          Returns the description for the PTF group.
 int getPTFGroupLevel()
          Returns the PTF Group Level.
 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.
 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 cannong 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 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 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 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 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
Method Detail

getSystem

public AS400 getSystem()
Returns the system.

Returns:
The system.

getRelatedPTFGroups

public PTFGroup[] getRelatedPTFGroups()
                               throws AS400Exception,
                                      AS400SecurityException,
                                      ErrorCompletingRequestException,
                                      InterruptedException,
                                      IOException,
                                      ObjectDoesNotExistException
Returns a list of Related PTF Groups.

Throws:
AS400Exception
AS400SecurityException
ErrorCompletingRequestException
InterruptedException
IOException
ObjectDoesNotExistException

getPTFGroupDescription

public String getPTFGroupDescription()
                              throws AS400Exception,
                                     AS400SecurityException,
                                     ErrorCompletingRequestException,
                                     InterruptedException,
                                     IOException,
                                     ObjectDoesNotExistException
Returns the description for the PTF group.

Returns:
the description
Throws:
AS400Exception
AS400SecurityException
ErrorCompletingRequestException
InterruptedException
IOException
ObjectDoesNotExistException

getPTFGroupName

public String getPTFGroupName()
                       throws AS400Exception,
                              AS400SecurityException,
                              ErrorCompletingRequestException,
                              InterruptedException,
                              IOException,
                              ObjectDoesNotExistException
Returns the PTF group name.

Returns:
the name.
Throws:
AS400Exception
AS400SecurityException
ErrorCompletingRequestException
InterruptedException
IOException
ObjectDoesNotExistException

getPTFGroupLevel

public int getPTFGroupLevel()
                     throws AS400Exception,
                            AS400SecurityException,
                            ErrorCompletingRequestException,
                            InterruptedException,
                            IOException,
                            ObjectDoesNotExistException
Returns the PTF Group Level.

Returns:
the PTF Group level, or 0 if the group level cannot be determined.
Throws:
AS400Exception
AS400SecurityException
ErrorCompletingRequestException
InterruptedException
IOException
ObjectDoesNotExistException

getPTFGroupStatus

public int getPTFGroupStatus()
                      throws AS400Exception,
                             AS400SecurityException,
                             ErrorCompletingRequestException,
                             InterruptedException,
                             IOException,
                             ObjectDoesNotExistException
Indicates the overall status of the PTF group on this system.

Returns:
the PTF group status. Possible Values are:

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,
                     InterruptedException,
                     IOException,
                     ObjectDoesNotExistException
Throws:
AS400Exception
AS400SecurityException
ErrorCompletingRequestException
InterruptedException
IOException
ObjectDoesNotExistException