psdi.app.workorder

Class FailureReportSet

java.lang.Object

psdi.mbo.MboSet

psdi.app.workorder.FailureReportSet

All Implemented Interfaces:

java.rmi.Remote, FailureReportSetRemote, MboAccessInterface, MboConstants, MboSetRemote, MaxRemoteProxy, Transactable, FixedLoggerNames, FixedLoggers

public class FailureReportSet
extends MboSet
implements FailureReportSetRemote

Represents the failure report for a work order. The method isComplete indicates when the report is complete. Also, new members to the set can only be added to the bottom of the set. All of the remote methods may return an MXApplicationException("workorder", "FRBroken") if the FailureReportSet's members do not make up a valid report.

Author:

John Neville

See Also:

FailureReport, FldWOFailureCode, FldWOProblemCode, FldFRCode

Field Summary

Fields inherited from class psdi.mbo.MboSet

fetchStopLimitEnabled, LOOKUPMAXROW, maxSorterSize, mboCountCleanuplist, perfStats, strNoBaseLangValueEntered

Fields inherited from interface psdi.app.workorder.FailureReportSetRemote

FAILURECODE, FAILURELIST

Fields inherited from interface psdi.mbo.MboSetRemote

INSERTONLY, INSERTORUPDATE, UPDATEONLY

Fields inherited from interface psdi.mbo.MboConstants

ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER

Fields inherited from interface psdi.util.logging.FixedLoggers

APPLOGGER, CRONTASKLOGGER, CRONTASKMGRLOGGER, CRONTASKMGRSQLLOGGER, DBCONNECTIONLOGGER, DDLOGGER, DMLOGGER, EVENTLOGGER, EXCEPTIONLOGGER, MAILLOGGER, MAXIMOLOGGER, MTLOGGER, NULLMBOPOINTER, SECURITY, SENDFAILEDLOGGER, SERVICELOGGER, SQLLOGGER

Fields inherited from interface psdi.util.logging.FixedLoggerNames

appenderPrefix, LOGGERNAME_APP, LOGGERNAME_CRONTASK, LOGGERNAME_CRONTASKMGR, LOGGERNAME_DBCONNECTION, LOGGERNAME_DD, LOGGERNAME_DM, LOGGERNAME_DMPREVIEW, LOGGERNAME_EVENT, LOGGERNAME_EXCEPTION, LOGGERNAME_MAIL, LOGGERNAME_MAXIMO, LOGGERNAME_MT, LOGGERNAME_NULLMBOPOINTER, LOGGERNAME_SECURITY, LOGGERNAME_SENDFAILED, LOGGERNAME_SERVICE, LOGGERNAME_SQL, LOGGERNAME_SQL_CRONTASKMGR, LOGGERNAME_TXN, loggerPrefix

Constructor Summary

Constructors

Constructor and Description
FailureReportSet(MboServerInterface ms) Construct the set

Method Summary

Modifier and Type	Method and Description
MboRemote	addAtIndex(long accessModifier, int index) The add method is restricted to adding to the end of the failure report.
void	canAdd() Can't add if the report is complete or if the owning work order does not have a value for its FailureCode attribute.
void	clearFromHere(FailureReport fr) Delete from the passed FR down to the end of the failure report.
void	codeSet(MboRemote forThisFR) Called when a FR's FailureCode is set and should be called after the LineNum attribute is set.
void	deleteAll(long accessModifier) Overridden for efficancy's sake.
boolean	doDelete() Called by FR's when they are to be deleted.
boolean	doUndelete() Called by FR's when they are to be deleted.
MboRemote	getEndOfReport() Returns the end of the failure report.
MboRemote	getMbo(int index) Overrode getMbo to return the nth mbo in the ordered report.
java.lang.String	getParentOfProblemCode() Returns the parent key into FailureList for the 1st level of the report.
boolean	isComplete() Returns whether this report can be added to.
boolean	isLevelEditable(int levelNum) Registers FR<#>Code attributes on the Work Order
void	reflectFailureClass() Called when the WO's FailureCode attribute's value is changed.
void	reflectProblemCode() Called when the WO's ProblemCode attribute is updated.
void	refreshFRCodes() Refreshes the values of the FR<#>Code attributes on the work order
void	register(int levelNum)
void	setOwner(MboRemote mbo) setOwner is overridden so we can save a reference to the workorder owner.
void	undeleteAll() Once a FR is deleted, it can't be undeleted.
void	undeleteFromHere(FailureReport fr)

Methods inherited from class psdi.mbo.MboSet

abortSql, add, add, addAtEnd, addAtEnd, addAtIndex, addFakeAtEnd, addFederatedMboToSorter, addSubQbe, addSubQbe, addSubQbe, addSubQbe, addToEndOfSelectStatement, addWarning, addWarnings, appendToWhere, applyRowSecurity, avg, cancelAndClose, checkMethodAccess, checkMethodAccess, cleanup, clear, clearBatchedPreparedStmt, clearBatchedPreparedStmts, clearESigTransactionIdThread, clearESigTransIDForAdmin, clearIgnoredAutokeyAttrs, clearLongOpPipe, clearToBeSaved, clearTransactionReference, clearWarnings, close, commit, commitTransaction, copy, copy, copy, copyForDM, count, count, deleteAll, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemoveAll, deleteAndRemoveAll, determineRequiredFieldsFromERM, dump, earliestDate, enableMethod, executeBatch, fetchNext, findAllNullRequiredFields, findByIntegrationKey, findKey, fireEventsAfterDB, fireEventsAfterDBCommit, fireEventsBeforeDB, forceDBSort, getAllowQualifiedRestriction, getAlwaysFlags, getAlwaysFlags, getApp, getAppAlwaysFieldFlags, getAppWhere, getAttrRestrictions, getBoolean, getByte, getBytes, getClientLocale, getClientTimeZone, getCompleteWhere, getCurrentPosition, getDate, getDBFetchMaxRows, getDefaultValue, getDefaultValueHash, getDouble, getERMEntity, getESigTransactionId, getExcludeMeFromPropagation, getFlags, getFloat, getIgnoredAutokeyAttrs, getInsertCompanySet, getInsertItemSet, getInsertOrg, getInsertSite, getInt, getJspDefaultValueHash, getKeyAttributes, getList, getList, getLong, getMaxAppsWhere, getMaxMessage, getMbo, getMboForUniqueId, getMboLogger, getMboServer, getMboSetData, getMboSetData, getMboSetInfo, getMboSetRetainMboPositionData, getMboSetRetainMboPositionInfo, getMboSetValueData, getMboSetValueData, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMLFromClause, getMultiSiteWhere, getMXTransaction, getName, getOrderBy, getOwner, getParentApp, getPreparedStmt, getProfile, getProxy, getQbe, getQbe, getQbe, getQbeSiteAuthorization, getQbeWhere, getQualifiedWhere, getQueryTimeout, getRelationName, getRelationship, getRowRestrictions, getSecurityLogger, getSelection, getSelectionWhere, getSetOrderByForUI, getSharedMboSet, getSize, getSkipFirstNRows, getSqlLogger, getSQLOptions, getString, getTxnPropertyMap, getUserAndQbeWhere, getUserInfo, getUserName, getUserPrefWhere, getUserWhere, getUserWhere, getWarnings, getWhere, getZombie, handleMLMbo, handleMLMbo, hasMLQbe, hasQbe, hasWarnings, ignoreAutokeyAttr, ignoreAutokeyAttr, ignoreQbeExactMatchSet, incrementDeletedCount, init, init, initDataDictionary, isBasedOn, isClosed, isDeltaStorage, isDMDeploySet, isDMSkipFieldValidation, isEAuditFieldModified, isEmpty, isESigFieldModified, isESigNeeded, isFlagSet, isIgnoreQbeExactMatchSet, isLookup, isNull, isQbeCaseSensitive, isQbeExactMatch, isRetainMboPosition, isTableDomainLookup, latestDate, locateMbo, logESigVerification, logRowUpdatedException, max, min, moveFirst, moveLast, moveNext, movePrev, moveTo, moveToKey, newMboIndex, notExist, positionState, processML, remove, remove, remove, reset, resetForRefreshOnSave, resetQbe, resetWithSelection, rollback, rollbackToCheckpoint, rollbackToCheckpoint, rollbackTransaction, save, save, save, save, saveMbos, saveTransaction, select, select, select, selectAll, setAllowQualifiedRestriction, setApp, setAppAlwaysFieldFlag, setAppWhere, setAutoKeyFlag, setDBFetchMaxRows, setDefaultOrderBy, setDefaultValue, setDefaultValue, setDefaultValues, setDefaultValues, setDMDeploySet, setDMSkipFieldValidation, setEAuditFieldModified, setERMEntity, setESigFieldModified, setExcludeMeFromPropagation, setFederatedResources, setFlag, setFlag, setFlags, setInsertCompanySet, setInsertItemSet, setInsertOrg, setInsertSite, setLastESigTransId, setLogLargFetchResultDisabled, setMboSetInfo, setMXTransaction, setNoNeedtoFetchFromDB, setOrderBy, setOrderByNVL, setPreserveOrderByCase, setProxy, setQbe, setQbe, setQbe, setQbe, setQbe, setQbeCaseSensitive, setQbeCaseSensitive, setQbeExactMatch, setQbeExactMatch, setQbeOperatorOr, setQueryBySiteQbe, setQueryTimeout, setRelationName, setRelationship, setRequiedFlagsFromERM, setRetainMboPosition, setSetOrderByForUI, setSkipFirstNRows, setSQLOptions, setTableDomainLookup, setTxnPropertyMap, setupLongOpPipe, setUserWhere, setUserWhereAfterParse, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, setWhere, setWhereQbe, smartFill, smartFill, smartFind, smartFind, smartFind, smartFind, sort, splitOrderBy, startCheckpoint, startCheckpoint, sum, toBeSaved, undoTransaction, unselect, unselect, unselect, unselectAll, useStoredQuery, validate, validateTransaction, verifyESig

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.mbo.MboSetRemote

abortSql, add, add, addAtEnd, addAtEnd, addAtIndex, addFakeAtEnd, addSubQbe, addSubQbe, addSubQbe, addSubQbe, addWarning, addWarnings, checkMethodAccess, cleanup, clear, clearLongOpPipe, close, commit, copy, copy, copyForDM, count, count, deleteAll, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemove, deleteAndRemoveAll, deleteAndRemoveAll, determineRequiredFieldsFromERM, earliestDate, fetchNext, findAllNullRequiredFields, findByIntegrationKey, findKey, getApp, getAppAlwaysFieldFlags, getAppWhere, getCompleteWhere, getCurrentPosition, getDBFetchMaxRows, getDefaultValue, getERMEntity, getESigTransactionId, getExcludeMeFromPropagation, getFlags, getKeyAttributes, getList, getList, getMaxMessage, getMbo, getMboForUniqueId, getMboSetData, getMboSetData, getMboSetInfo, getMboSetRetainMboPositionData, getMboSetRetainMboPositionInfo, getMboSetValueData, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMLFromClause, getMXTransaction, getName, getOrderBy, getOwner, getParentApp, getProfile, getQbe, getQbe, getQbe, getQbeWhere, getQueryTimeout, getRelationName, getRelationship, getSelection, getSelectionWhere, getSetOrderByForUI, getSize, getSQLOptions, getTxnPropertyMap, getUserAndQbeWhere, getUserInfo, getUserName, getUserWhere, getWarnings, getWhere, getZombie, hasMLQbe, hasQbe, hasWarnings, ignoreQbeExactMatchSet, incrementDeletedCount, init, isBasedOn, isDMDeploySet, isDMSkipFieldValidation, isEmpty, isESigNeeded, isFlagSet, isQbeCaseSensitive, isQbeExactMatch, isRetainMboPosition, latestDate, locateMbo, logESigVerification, max, min, moveFirst, moveLast, moveNext, movePrev, moveTo, newMboIndex, notExist, positionState, processML, remove, remove, remove, reset, resetQbe, resetWithSelection, rollback, rollbackToCheckpoint, rollbackToCheckpoint, save, save, select, select, select, selectAll, setAllowQualifiedRestriction, setApp, setAppAlwaysFieldFlag, setAppWhere, setAutoKeyFlag, setDBFetchMaxRows, setDefaultOrderBy, setDefaultValue, setDefaultValue, setDefaultValues, setDMDeploySet, setDMSkipFieldValidation, setERMEntity, setESigFieldModified, setExcludeMeFromPropagation, setFlag, setFlag, setFlags, setInsertCompanySet, setInsertItemSet, setInsertOrg, setInsertSite, setLastESigTransId, setLogLargFetchResultDisabled, setMboSetInfo, setMXTransaction, setNoNeedtoFetchFromDB, setOrderBy, setQbe, setQbe, setQbe, setQbe, setQbe, setQbeCaseSensitive, setQbeCaseSensitive, setQbeExactMatch, setQbeExactMatch, setQbeOperatorOr, setQueryBySiteQbe, setQueryTimeout, setRelationName, setRelationship, setRequiedFlagsFromERM, setRetainMboPosition, setSetOrderByForUI, setSQLOptions, setTableDomainLookup, setTxnPropertyMap, setupLongOpPipe, setUserWhere, setUserWhereAfterParse, setWhere, setWhereQbe, smartFill, smartFill, smartFind, smartFind, startCheckpoint, startCheckpoint, sum, toBeSaved, unselect, unselect, unselect, unselectAll, useStoredQuery, validate, verifyESig

Methods inherited from interface psdi.mbo.MboAccessInterface

getBoolean, getByte, getBytes, getDate, getDouble, getFloat, getInt, getLong, getString, isNull, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull

Methods inherited from interface psdi.txn.Transactable

commitTransaction, fireEventsAfterDB, fireEventsAfterDBCommit, fireEventsBeforeDB, rollbackTransaction, saveTransaction, undoTransaction, validateTransaction

Constructor Detail

FailureReportSet

public FailureReportSet(MboServerInterface ms)
                 throws MXException,
                        java.rmi.RemoteException

Construct the set

Parameters:

ms - The MboServerInterface of failure report.

Throws:

MXException

java.rmi.RemoteException

Method Detail

setOwner

public void setOwner(MboRemote mbo)
              throws MXException,
                     java.rmi.RemoteException

setOwner is overridden so we can save a reference to the workorder owner.

Specified by:

setOwner in interface MboSetRemote

Overrides:

setOwner in class MboSet

Parameters:

mbo - The owner Mbo of the failure report, it should be WORKORDER or null.

Throws:

MXException

java.rmi.RemoteException

canAdd

public void canAdd()
            throws MXException

Can't add if the report is complete or if the owning work order does not have a value for its FailureCode attribute.

Overrides:

canAdd in class MboSet

Throws:

MXAccessException - Thrown with "access","method" when it's not possible to add to the failure report.

MXApplicationException - Thrown with "workorder", "FRNoEditWithOutWO" if this set isn't owned by its work order.

MXException

addAtIndex

public MboRemote addAtIndex(long accessModifier,
                            int index)
                     throws MXException,
                            java.rmi.RemoteException

The add method is restricted to adding to the end of the failure report. When an FR is added, another may not be added until the new FR's FailureCode attribute is set.

Specified by:

addAtIndex in interface MboSetRemote

Overrides:

addAtIndex in class MboSet

Parameters:

accessModifier -

index - Where to add the new Mbo. Zero is the beginning, while -1 will put the Mbo at the end of the MboSet.

Throws:

MXException

java.rmi.RemoteException

See Also:

MboSet.getMboInstance(psdi.mbo.MboSet), MboSet.addMbo(Mbo), MboSet.addMbo(Mbo, int), MboSet.moveTo(int)

doDelete

public boolean doDelete()

Called by FR's when they are to be deleted. If they should just delete, this function returns true. Otherwise the FR.delete will call clearFromHere to take control of the deletions.

clearFromHere

public void clearFromHere(FailureReport fr)
                   throws MXException,
                          java.rmi.RemoteException

Delete from the passed FR down to the end of the failure report. Updates internal variables. Normally called via the FR's delete method. Will clear the workorder's ProblemCode if the first level of the report is deleted.

Parameters:

fr - The level to delete from.

Throws:

MXApplicationException - FRBroken when the FR to delete is not found.

MXException

java.rmi.RemoteException

deleteAll

public void deleteAll(long accessModifier)
               throws MXException,
                      java.rmi.RemoteException

Overridden for efficancy's sake. Will clear the work order's ProblemCode.

Specified by:

deleteAll in interface MboSetRemote

Overrides:

deleteAll in class MboSet

Parameters:

accessModifier -

Throws:

MXException

java.rmi.RemoteException

codeSet

public void codeSet(MboRemote forThisFR)
             throws MXException,
                    java.rmi.RemoteException

Called when a FR's FailureCode is set and should be called after the LineNum attribute is set. Updates internal variables. Changing the failure code deletes any FRs in the report after the one whose code is changing. Will update the ProblemCode if the first level's failure code changes.

Parameters:

forThisFR - The FailureReport line whose FailureCode attribute changed.

Throws:

MXException

java.rmi.RemoteException

See Also:

FldFRCode

isComplete

public boolean isComplete()
                   throws MXException,
                          java.rmi.RemoteException

Returns whether this report can be added to. Returns true if the failure report cannot be extended. Also returns false if the WO's Failure Code is not set since no report lines can be written with out it.

Specified by:

isComplete in interface FailureReportSetRemote

Returns:

true if this report be added to.

Throws:

MXException

java.rmi.RemoteException

See Also:

isComplete()

reflectFailureClass

public void reflectFailureClass()
                         throws MXException,
                                java.rmi.RemoteException

Called when the WO's FailureCode attribute's value is changed. Clears any existing failure report.

Throws:

MXException

java.rmi.RemoteException

See Also:

FldWOFailureCode

reflectProblemCode

public void reflectProblemCode()
                        throws MXException,
                               java.rmi.RemoteException

Called when the WO's ProblemCode attribute is updated. Starts or modifies the FailureReport.

Throws:

MXException

java.rmi.RemoteException

See Also:

FldWOProblemCode

getParentOfProblemCode

public java.lang.String getParentOfProblemCode()
                                        throws MXException,
                                               java.rmi.RemoteException

Returns the parent key into FailureList for the 1st level of the report. For validation of the WO ProblemCode attribute. Returns the FailureList parent of the work order's problem code, a.k.a. the parent of the first level.

Specified by:

getParentOfProblemCode in interface FailureReportSetRemote

Returns:

The parent in the failure list heirarchy of the problem code.

Throws:

MXException

java.rmi.RemoteException

See Also:

getParentOfProblemCode()

getMbo

public MboRemote getMbo(int index)
                 throws MXException,
                        java.rmi.RemoteException

Overrode getMbo to return the nth mbo in the ordered report. Returns null if n is past the end of the report.

Specified by:

getMbo in interface MboSetRemote

Overrides:

getMbo in class MboSet

Parameters:

index - The number of the report level to return.

Returns:

The MboRemote of the report specified by index.

Throws:

MXException

java.rmi.RemoteException

See Also:

MboSet.fetchMbos(int), MboSet.loadMboVecFromMrd(int)

undeleteAll

public void undeleteAll()
                 throws MXException,
                        java.rmi.RemoteException

Once a FR is deleted, it can't be undeleted.

Specified by:

undeleteAll in interface MboSetRemote

Overrides:

undeleteAll in class MboSet

Throws:

MXException

java.rmi.RemoteException

See Also:

MboSet.undeleteAll()

getEndOfReport

public MboRemote getEndOfReport()
                         throws MXException,
                                java.rmi.RemoteException

Returns the end of the failure report. If the failure report is complete, null is returned. If the last level of the report doesn't have a null failure code, another level is added. If the return value isn't null, than the MboRemote will have null for the FailureCode attribute.

Specified by:

getEndOfReport in interface FailureReportSetRemote

Returns:

the end Mbo of the failure report or null.

Throws:

MXException

java.rmi.RemoteException

See Also:

getEndOfReport()

register

public void register(int levelNum)

isLevelEditable

public boolean isLevelEditable(int levelNum)
                        throws MXException,
                               java.rmi.RemoteException

Registers FR<#>Code attributes on the Work Order

Throws:

MXException

java.rmi.RemoteException

refreshFRCodes

public void refreshFRCodes()
                    throws MXException,
                           java.rmi.RemoteException

Refreshes the values of the FR<#>Code attributes on the work order

Throws:

MXException

java.rmi.RemoteException

doUndelete

public boolean doUndelete()

Called by FR's when they are to be deleted. If they should just delete, this function returns true. Otherwise the FR.delete will call clearFromHere to take control of the deletions.

undeleteFromHere

public void undeleteFromHere(FailureReport fr)
                      throws MXException,
                             java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException