Package com.ibm.as400.access

Class PTFExitProgram

java.lang.Object

com.ibm.as400.access.PTFExitProgram

public class PTFExitProgram
extends 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	Description
static 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 String	STAGE_APPLY	Constant indicating that the exit program will be run at the end of apply processing.
static String	STAGE_BOTH	Constant indicating that the exit program will be run at the end of apply and remove processing.
static 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 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 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 String	STAGE_REMOVE	Constant indicating that the exit program will be run at the end of remove processing.

Method Summary

Modifier and Type	Method	Description
String	getPath()	Returns the full pathname of the exit program.
String	getRunStage()	Returns the stage of the PTF process in which the exit program will be run.
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 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 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 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 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 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 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 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 String getPath()

Returns the full pathname of the exit program.

Returns:

The path.

getRunStage

public String getRunStage()

Returns the stage of the PTF process in which the exit program will be run. Possible values are:

• STAGE_ACTION
• STAGE_BOTH
• STAGE_APPLY
• STAGE_REMOVE
• STAGE_PRE_APPLY
• STAGE_PRE_REMOVE
• STAGE_PRE_BOTH

Returns:

The run stage.

getUserData

public String getUserData()

Returns any user data associated with this exit program.

Returns:

The user data.