com.ibm.tivoli.maximo.integrity

Class IntegrityCheck

java.lang.Object

com.ibm.tivoli.maximo.integrity.IntegrityCheck

All Implemented Interfaces:

ICConstants

Direct Known Subclasses:

CheckConfigurations, CheckDatabaseVersion, CheckForBackupTables, CheckSearchTypes, CheckSequences, CheckTenantData, FGACCheck, VerifyAppMenuPositions, VerifyIndexRequired, VerifyMaximoColumns, VerifyMaximoTables, ZTriggerCheck

public abstract class IntegrityCheck
extends java.lang.Object
implements ICConstants

Base class that performs some check of the Maximo database.

Field Summary

Fields

Modifier and Type	Field and Description
protected DatabaseInformation	di Link to the database, include a connection object.
protected ReportCollector	rc
protected ValidateLogger	vl

Fields inherited from interface com.ibm.tivoli.maximo.integrity.ICConstants

IC_ALLREPAIRS, IC_CANCEL, IC_CHECK, IC_CHECKDONE, IC_NOTAPPLY, IC_REPAIR, IC_REPORT, IC_TENANT

Constructor Summary

Constructors

Constructor and Description
IntegrityCheck(DatabaseInformation di, ReportCollector reportCollector) Constructor takes the object where to report problems.
IntegrityCheck(DatabaseInformation di, ReportCollector reportCollector, ValidateLogger validateLogger)

Method Summary

Modifier and Type	Method and Description
protected abstract void	check() Override this to perform the check.
abstract boolean	conditionsCheck() Should this test be run? This is for things like preMerlin or DB2 only checks.
void	doCheck() Perform this check.
abstract MXException	getTitle() Returns an MXException that tells the user what is being checked now.
abstract boolean	prerequisitesCheck() Can this test be run now? This is for things like loading the meta data, or having valid data in the MaxAttribute table.
protected void	reportProblem(Report report) Called by sub-classes to report problems.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

di

protected DatabaseInformation di

Link to the database, include a connection object.

rc

protected ReportCollector rc

vl

protected ValidateLogger vl

Constructor Detail

IntegrityCheck

public IntegrityCheck(DatabaseInformation di,
                      ReportCollector reportCollector)

Constructor takes the object where to report problems.

Parameters:

di - This object has information about the database.

reportCollector - Where to report problems.

IntegrityCheck

public IntegrityCheck(DatabaseInformation di,
                      ReportCollector reportCollector,
                      ValidateLogger validateLogger)

Method Detail

reportProblem

protected void reportProblem(Report report)
                      throws java.lang.Exception

Called by sub-classes to report problems.

Parameters:

report -

Throws:

java.lang.Exception

getTitle

public abstract MXException getTitle()

Returns an MXException that tells the user what is being checked now. "Checking for any workflow loops that may exist."

conditionsCheck

public abstract boolean conditionsCheck()
                                 throws java.lang.Exception

Should this test be run? This is for things like preMerlin or DB2 only checks. It's not an issue if test won't run because the conditions don't apply to it.

Parameters:

mdi -

Returns:

true if the conditions are correct for the check.

Throws:

java.sql.SQLException

java.lang.Exception

prerequisitesCheck

public abstract boolean prerequisitesCheck()

Can this test be run now? This is for things like loading the meta data, or having valid data in the MaxAttribute table. The test should run after other problems are resolved.

Parameters:

mdi -

Returns:

true if all prerequisites are there to run the check.

doCheck

public final void doCheck()
                   throws java.lang.Exception

Perform this check. If conditions or prerequisites aren't correct, the test won't run.

Parameters:

mdi -

Throws:

java.lang.Exception

See Also:

called first, called second, only called if the first two return true.

check

protected abstract void check()
                       throws java.lang.Exception

Override this to perform the check.

Throws:

java.lang.Exception

See Also:

Problems are reported to the report collector.