com.ibm.ims.dli.tm

Interface SaveArea

All Superinterfaces:

java.io.Serializable

public interface SaveArea
extends java.io.Serializable

Use this interface during symbolic checkpoint and restart calls to store and retrieve application state information.

Method Summary

Modifier and Type	Method and Description
void	addObject(java.lang.Object obj) Stores an object in the SaveArea instance.
void	clear() Resets the SaveArea instance by removing all application objects.
java.lang.String[]	getInvalidPCBs() Returns the list of PCBs that were not reset correctly after a symbolic restart call was issued.
java.lang.Object	getObject(int index) Retrieves objects stored inside the SaveArea instance.
boolean	isEmpty() Checks for any objects saved in the SaveArea instance.
java.util.Iterator	retrieveObjects() Retrieves all objects stored inside the SaveArea instance.
void	setInvalidPCBs(java.lang.String pcbName) Stores the name of a PCB that was not reset after a symbolic restart call.
int	size() Returns the number of objects stored in the SaveArea instance.
boolean	verifyPCBPosition(java.lang.String pcbName) Verifies correct repositioning of a PCB after a restart call.
boolean	verifyPCBPosition(java.lang.String[] pcbArray) Use this method to confirm correct repositioning of a PCB after a restart (XRST) call.

Method Detail

retrieveObjects

java.util.Iterator retrieveObjects()

Retrieves all objects stored inside the SaveArea instance.

Returns:

an Iterator containing the saved objects.

getObject

java.lang.Object getObject(int index)
                    throws TMException

Retrieves objects stored inside the SaveArea instance. The objects will be retrieved according to the order that they were stored.

Parameters:

index - a 1-based index indicating the order of saved objects.

Returns:

Object a object stored in the SaveArea instance.

Throws:

TMException

addObject

void addObject(java.lang.Object obj)

Stores an object in the SaveArea instance.

Parameters:

obj - the object to save.

isEmpty

boolean isEmpty()

Checks for any objects saved in the SaveArea instance.

Returns:

boolean true if no objects are stored in the SaveArea instance and false otherwise

size

int size()

Returns the number of objects stored in the SaveArea instance.

Returns:

count of objects stored in the SaveArea instance.

verifyPCBPosition

boolean verifyPCBPosition(java.lang.String[] pcbArray)
                   throws DLIException

Use this method to confirm correct repositioning of a PCB after a restart (XRST) call. Following a restart, IMS attempts to reposition its databases to the positions existing at the time of the chosen checkpoint, using information saved in the checkpoint on the IMS log.

Parameters:

pcbArray - a String array of PCB reference or alias names as defined in the Java metadata class that provides the database view.

Returns:

boolean true if the PCB was correctly repositioned, false otherwise. If false, the PCB may not be correctly repositioned, and the application must take whatever action is required to ensure valid results before resuming processing.

Throws:

DLIException

verifyPCBPosition

boolean verifyPCBPosition(java.lang.String pcbName)
                   throws DLIException

Verifies correct repositioning of a PCB after a restart call.

Returns:

boolean true if the PCB was correctly repositioned, false otherwise. If false, the PCB may not be correctly repositioned, and the application must take whatever action is required to ensure valid results before resuming processing.

Throws:

DLIException

getInvalidPCBs

java.lang.String[] getInvalidPCBs()

Returns the list of PCBs that were not reset correctly after a symbolic restart call was issued.

Returns:

the array of PCB names

setInvalidPCBs

void setInvalidPCBs(java.lang.String pcbName)

Stores the name of a PCB that was not reset after a symbolic restart call.

Parameters:

pcbName - the name of the PCB

clear

void clear()

Resets the SaveArea instance by removing all application objects.