com.ibm.as400.access
Class PTFCoverLetter

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

public class PTFCoverLetter
extends Object

Represents a cover letter for a Program Temporary Fix (PTF). Use PTF.getCoverLetters() to generate a PTFCoverLetter object.


Field Summary
static int SPECIAL_INSTRUCTIONS_IMMEDIATE
          Constant indicating that the cover letter does have pre-apply or pre-remove special instructions, but only when the PTF is applied or removed immediately.
static int SPECIAL_INSTRUCTIONS_IPL
          Constant indicating that the cover letter does have pre-apply or pre-remove special instructions, but only when the PTF is applied or removed during an IPL.
static int SPECIAL_INSTRUCTIONS_NO
          Constant indicating that the cover letter does not have any special instructions.
static int SPECIAL_INSTRUCTIONS_UNKNOWN
          Constant indicating that it is not known if the cover letter has special instructions.
static int SPECIAL_INSTRUCTIONS_YES
          Constant indicating that the cover letter does have special instructions.
 
Method Summary
 Reader getContents()
          Returns a Reader object that can be used to read the contents of this cover letter.
 String getNLV()
          Returns the National Language Version (NLV) for this cover letter.
 String getPath()
          Returns the full pathname to this cover letter on the system.
 int getPostSpecialInstructions()
          Returns whether the cover letter contains special instructions that should be followed after applying or removing the PTF.
 int getPreSpecialInstructions()
          Returns whether the cover letter contains special instructions that should be followed prior to applying or removing the PTF.
 AS400 getSystem()
          Returns the system.
 String toString()
          Returns a String representation of this cover letter.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

SPECIAL_INSTRUCTIONS_NO

public static final int SPECIAL_INSTRUCTIONS_NO
Constant indicating that the cover letter does not have any special instructions.

See Also:
Constant Field Values

SPECIAL_INSTRUCTIONS_YES

public static final int SPECIAL_INSTRUCTIONS_YES
Constant indicating that the cover letter does have special instructions. In the case of pre-apply or pre-remove considerations, this constant indicates that the considerations should be followed regardless of how the PTF is applied or removed (either immediately or during an IPL).

See Also:
Constant Field Values

SPECIAL_INSTRUCTIONS_IMMEDIATE

public static final int SPECIAL_INSTRUCTIONS_IMMEDIATE
Constant indicating that the cover letter does have pre-apply or pre-remove special instructions, but only when the PTF is applied or removed immediately.

See Also:
Constant Field Values

SPECIAL_INSTRUCTIONS_IPL

public static final int SPECIAL_INSTRUCTIONS_IPL
Constant indicating that the cover letter does have pre-apply or pre-remove special instructions, but only when the PTF is applied or removed during an IPL.

See Also:
Constant Field Values

SPECIAL_INSTRUCTIONS_UNKNOWN

public static final int SPECIAL_INSTRUCTIONS_UNKNOWN
Constant indicating that it is not known if the cover letter has special instructions. The most likely reasons are that the cover letter was created prior to V5R1M0, or the cover letter was created using the System Manager licensed product.

See Also:
Constant Field Values
Method Detail

getContents

public Reader getContents()
                   throws AS400Exception,
                          AS400SecurityException,
                          ErrorCompletingRequestException,
                          InterruptedException,
                          IOException,
                          ObjectDoesNotExistException
Returns a Reader object that can be used to read the contents of this cover letter. The text is automatically converted to Unicode based on the NLV of this cover letter.

Returns:
The cover letter reader.
Throws:
AS400Exception
AS400SecurityException
ErrorCompletingRequestException
InterruptedException
IOException
ObjectDoesNotExistException

getNLV

public String getNLV()
Returns the National Language Version (NLV) for this cover letter.

Returns:
The NLV (e.g. "2938").

getPath

public String getPath()
Returns the full pathname to this cover letter on the system.

Returns:
The path.

getPostSpecialInstructions

public int getPostSpecialInstructions()
Returns whether the cover letter contains special instructions that should be followed after applying or removing the PTF. Possible values are:

Returns:
The type of post-apply or post-remove special instructions.

getPreSpecialInstructions

public int getPreSpecialInstructions()
Returns whether the cover letter contains special instructions that should be followed prior to applying or removing the PTF. Possible values are:

Returns:
The type of pre-apply or pre-remove special instructions.

getSystem

public AS400 getSystem()
Returns the system.

Returns:
The system.

toString

public String toString()
Returns a String representation of this cover letter. This is just the path to the cover letter.

Returns:
The String object.