com.ibm.as400.access

Class PTFExitProgram

  • java.lang.Object
    • com.ibm.as400.access.PTFExitProgram


  • public class PTFExitProgram
    extends java.lang.Object
    Represents an exit program for a Program Temporary Fix (PTF). Use PTF.getExitPrograms() to generate a PTFExitProgram object.
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String STAGE_ACTION
      Constant indicating that the exit program is called to determine if there is action necessary to make the PTF active or inactive.
      static java.lang.String STAGE_APPLY
      Constant indicating that the exit program will be run at the end of apply processing.
      static java.lang.String STAGE_BOTH
      Constant indicating that the exit program will be run at the end of apply and remove processing.
      static java.lang.String STAGE_PRE_APPLY
      Constant indicating that the exit program will be run before the PTF is applied and at the end of apply processing.
      static java.lang.String STAGE_PRE_BOTH
      Constant indicating that the exit program will be run before the PTF is removed and at the end of remove processing.
      static java.lang.String STAGE_PRE_REMOVE
      Constant indicating that the exit program will be run before the PTF is removed and at the end of remove processing.
      static java.lang.String STAGE_REMOVE
      Constant indicating that the exit program will be run at the end of remove processing.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      java.lang.String getPath()
      Returns the full pathname of the exit program.
      java.lang.String getRunStage()
      Returns the stage of the PTF process in which the exit program will be run.
      java.lang.String getUserData()
      Returns any user data associated with this exit program.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • STAGE_ACTION

        public static final java.lang.String STAGE_ACTION
        Constant indicating that the exit program is called to determine if there is action necessary to make the PTF active or inactive.
        See Also:
        Constant Field Values
      • STAGE_BOTH

        public static final java.lang.String STAGE_BOTH
        Constant indicating that the exit program will be run at the end of apply and remove processing.
        See Also:
        Constant Field Values
      • STAGE_APPLY

        public static final java.lang.String STAGE_APPLY
        Constant indicating that the exit program will be run at the end of apply processing.
        See Also:
        Constant Field Values
      • STAGE_REMOVE

        public static final java.lang.String STAGE_REMOVE
        Constant indicating that the exit program will be run at the end of remove processing.
        See Also:
        Constant Field Values
      • STAGE_PRE_APPLY

        public static final java.lang.String STAGE_PRE_APPLY
        Constant indicating that the exit program will be run before the PTF is applied and at the end of apply processing.
        See Also:
        Constant Field Values
      • STAGE_PRE_REMOVE

        public static final java.lang.String STAGE_PRE_REMOVE
        Constant indicating that the exit program will be run before the PTF is removed and at the end of remove processing.
        See Also:
        Constant Field Values
      • STAGE_PRE_BOTH

        public static final java.lang.String STAGE_PRE_BOTH
        Constant indicating that the exit program will be run before the PTF is removed and at the end of remove processing. It is also run before the PTF is applied and at the end of apply processing.
        See Also:
        Constant Field Values
    >
    • Method Detail

      • getPath

        public java.lang.String getPath()
        Returns the full pathname of the exit program.
        Returns:
        The path.
      • getUserData

        public java.lang.String getUserData()
        Returns any user data associated with this exit program.
        Returns:
        The user data.