psdi.app.failure

Class FailureList

java.lang.Object

psdi.mbo.Mbo

psdi.app.failure.FailureList

All Implemented Interfaces:

java.rmi.Remote, FailureListRemote, MboConstants, MboRemote, MaxRemoteProxy

public class FailureList
extends Mbo
implements FailureListRemote

MBO to represent a failure hierarchy. See failure package description for detail.

This is a organization level object.

The key attributes for this object are OrgID and FailureList.

The attributes in this object are as follows:

Attribute Name	Description
FailureClass	Non-persistent attribute used to interact with top level FailureCode.FailureCode through this failurelist object.
FailureCode	Identifier of the FailureCode for this failurelist.
FailureList	Unique identifier for the failure list.
FLCDescription	Non-persistent attribute used to interact with top level FailureCode's description through this failurelist object.
OrgId	Identifier of the organization for this failurelist.
Parent	Parent failure list number.
Type	The type or level of this failure.

Field Summary

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

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

Constructor Summary

Constructors

Constructor and Description
FailureList(MboSet ms) The constructor for FailureList.

Method Summary

Methods

Modifier and Type	Method and Description
void	add() Sets defaults for a new failurelist object.
void	canDelete() This method determines if a FailureList record may be deleted.
boolean	checkFailureCode(java.lang.String fCode) Checks if this code is already exist in failurecode table.
boolean	checkFailureReport(java.lang.String failureReportCode) Checks if failurecode used in failurereport.
void	copyFailureCodes(MboSetRemote failureListSet) Copies the passed failurecodes as children of current list.
void	creatNewFailureHierarchy(java.lang.String newFailureCode) Creates a new failure hierarchy.
void	creatNewNode(java.lang.String newFailureCode) Creates a new node for current list.
void	delete(long accessModifier) Deletes this Failure List Node and all its children.
MboRemote	duplicate() Creates a duplicate failurelist hierarchy.
MboSetRemote	getChildren() Retrieves the child failures associated with this failure.
java.lang.String[]	getHierarchies() Gets failure's hierarchy.
MboSetRemote	getMboSet(java.lang.String name) Overridden to support faux MboSets
MboSetRemote	getParents() Retrieves the parent failure associated with this failure.
MboSetRemote	getTop() Gets this failurelist's top level failurelist.
boolean	hasChildren() Checks if this failure has children.
boolean	hasParents() Checks whether this failure has any parents.
void	init() Initailzation rountine.
boolean	isTop() Checks if this failure is the top level.
void	undelete() Undeletes this FailureList node, its FailureCode, and recursively the child nodes

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, fireEvent, generateAutoKey, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getRowRestrictionFlag, getRowStamp, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeRelatedSet, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, setEAuditFieldModified, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setReferencedMbo, setReferencedMbo, setUniqueIDValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromSequence, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, generateAutoKey, getBoolean, getByte, getBytes, getCommLogOwnerNameAndUniqueId, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainIDs, getDouble, getExistingMboSet, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInt, getKeyValue, getLinesRelationship, getList, getLockedByDisplayName, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboInitialValue, getMboList, getMboSet, getMboSet, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getPropagateKeyFlag, getRecordIdentifer, getSiteOrg, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getThisMboSet, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, hasHierarchyLink, hasLockSaveRights, isAutoKeyed, isBasedOn, isFlagSet, isForDM, isLocked, isLocked, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isZombie, lock, propagateKeyValue, rollbackToCheckpoint, select, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDeleted, setESigFieldModified, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setIgnoreRecordLockCheck, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setReferencedMbo, setReferencedMbo, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, unlock, unselect, validate, validateAttributes

Constructor Detail

FailureList

public FailureList(MboSet ms)
            throws MXException,
                   java.rmi.RemoteException

The constructor for FailureList.

Parameters:

ms - the FailureList MboSet.

Throws:

MXException

java.rmi.RemoteException

Method Detail

add

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

Sets defaults for a new failurelist object. If owned by another failurelist, the parent attribute is set to the owner's failurelist number.

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

init

public void init()
          throws MXException

Initailzation rountine. Failurelist attribute is always read-only.

Overrides:

init in class Mbo

Throws:

MXException

canDelete

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

This method determines if a FailureList record may be deleted. A top level failure list node may not be deleted if it is referenced by a WorkOrder, Asset, or Location.LocOper FailureCode. Failure List nodes not a top level may not be deleted if they are part of an existing Failure Report.

Overrides:

canDelete in class Mbo

Throws:

MXApplicationException - Thrown with "Failure" and one of the following: "NoDelWO", "NoDelAsset", "NoDelLoc", or "NoDelFR" depending on the reason why the failure list node may not be deleted.

MXException

java.rmi.RemoteException

undelete

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

Undeletes this FailureList node, its FailureCode, and recursively the child nodes

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

delete

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

Deletes this Failure List Node and all its children. If the related FailureCode records no longer represent any Failure List Nodes, the FailureCode is deleted also.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

accessModifier - The bitwise flag specified to determine if certain normal security checks are to be bypassed for this delete request. For example: if the accessModifer is NOACCESSCHECK, then the check for the object's NODELETE flag and the call to the object's canDelete() method will not be performed. If the accessModifer is NONE, then all the access checks are performed before this object is marked delete.

Throws:

MXException

java.rmi.RemoteException

See Also:

Determines if this node can be deleted.

duplicate

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

Creates a duplicate failurelist hierarchy. Sets the failurecode of the new failurelist to the passed in String parameter.

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Returns:

the newly duplicated failurelist set.

Throws:

MXApplicationException - FailureCodeAlreadyExist when the failure already exist.

MXException

java.rmi.RemoteException

creatNewFailureHierarchy

public void creatNewFailureHierarchy(java.lang.String newFailureCode)
                              throws MXException,
                                     java.rmi.RemoteException

Creates a new failure hierarchy.

Specified by:

creatNewFailureHierarchy in interface FailureListRemote

Parameters:

newFailureCode - the Failure code of the failure to be created.

Throws:

MXException

java.rmi.RemoteException

See Also:

creatNewFailureHierarchy(String newFailureCode).

copyFailureCodes

public void copyFailureCodes(MboSetRemote failureListSet)
                      throws MXException,
                             java.rmi.RemoteException

Copies the passed failurecodes as children of current list.

Specified by:

copyFailureCodes in interface FailureListRemote

Parameters:

failureListSet - the failureListSet to be copied.

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.failure.FailureList#copyFailureCodes(String failurecodetocopy[]).

creatNewNode

public void creatNewNode(java.lang.String newFailureCode)
                  throws MXException,
                         java.rmi.RemoteException

Creates a new node for current list.

Specified by:

creatNewNode in interface FailureListRemote

Parameters:

newfailurecode - the new node's failurecode.

Throws:

MXException

java.rmi.RemoteException

See Also:

creatNewNode(String newFailureCode).

checkFailureReport

public boolean checkFailureReport(java.lang.String failureReportCode)
                           throws MXException,
                                  java.rmi.RemoteException

Checks if failurecode used in failurereport.

Parameters:

failureReportCode - the failurecode to be checked in failurereport.

Returns:

true if the failurecode used in failurereport, false if not.

Throws:

MXException

java.rmi.RemoteException

checkFailureCode

public boolean checkFailureCode(java.lang.String fCode)
                         throws MXException,
                                java.rmi.RemoteException

Checks if this code is already exist in failurecode table.

Parameters:

failurecode - the failurecode to be checked.

Returns:

true if the code exist in the failurecode table, false if not.

Throws:

MXException

java.rmi.RemoteException

isTop

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

Checks if this failure is the top level.

Returns:

true if the failure doesn't have a parent.

Throws:

MXException

java.rmi.RemoteException

hasChildren

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

Checks if this failure has children.

Returns:

true if this failure has children.

Throws:

MXException

java.rmi.RemoteException

hasParents

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

Checks whether this failure has any parents.

Returns:

true if this failure has parents.

Throws:

MXException

java.rmi.RemoteException

getChildren

public MboSetRemote getChildren()
                         throws MXException,
                                java.rmi.RemoteException

Retrieves the child failures associated with this failure. Calling this method is the same as calling getMboSet(FailureListSetRemote.CHILDREN);

Returns:

this failure's child set.

Throws:

MXException

java.rmi.RemoteException

getParents

public MboSetRemote getParents()
                        throws MXException,
                               java.rmi.RemoteException

Retrieves the parent failure associated with this failure. Same as getMboSet(FailureListSetRemote.PARENT);

Returns:

this failure's parent set.

Throws:

MXException

java.rmi.RemoteException

getTop

public MboSetRemote getTop()
                    throws MXException,
                           java.rmi.RemoteException

Gets this failurelist's top level failurelist.

Returns:

this failure's top level parent.

Throws:

MXException

java.rmi.RemoteException

getHierarchies

public java.lang.String[] getHierarchies()
                                  throws MXException,
                                         java.rmi.RemoteException

Gets failure's hierarchy.

Returns:

failure's hierarchy arrary or null. Currently just return null.

Throws:

MXException

java.rmi.RemoteException

getMboSet

public MboSetRemote getMboSet(java.lang.String name)
                       throws MXException,
                              java.rmi.RemoteException

Overridden to support faux MboSets

Specified by:

getMboSet in interface MboRemote

Overrides:

getMboSet in class Mbo

Parameters:

name - The relationship provided to retrieve a related mboSet, usually using foreign keys. For example, "psdi.app.workorder.WOSetRemote.ASSET" is a relationship for the work order object to access the asset Set where "workorder.assetnum=asset.assetnum". The relationship can also be chained. Such as ASSET.ASSETSTATUS.

Returns:

The returned related set specified through the relationship.

Throws:

MXException - "A relationship called {0} does not exist for the {1} business object" exception will be thrown if the relationship was not found. "Unknown Object" exception will be thrown if the database object can not be found through the relationship.

java.rmi.RemoteException

See Also:

Mbo.getMboSet(String)