psdi.app.masterpm

Class MasterPM

java.lang.Object

psdi.mbo.Mbo

psdi.app.masterpm.MasterPM

All Implemented Interfaces:

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

public class MasterPM
extends Mbo
implements MasterPMRemote

MBO to represent MasterPM. See the MasterPM package description for details.

This is a system level object.

The key attributes for this object is MasterPMNum.

The attributes in this object are as follows:

Attribute Name	Description
AdjNextDue	A boolean flag that indicates whether the extdate will be used for calculating the next due date for the generation of workorders.
AlertLead	Acceptable period (in days), prior to the PM due date, during which the PM may be performed.
ApplyMPMToAsset	A boolean field that indicates whether to list the asset when creating the associated PM's from this MasterPM.
ApplyMPMToLoc	A boolean field that indicates whether to list the location that is associated with the item when creating the associated PM's from this MasterPM or not.
ChangeBy, ChangeDate	The name of the person who last modified the form and the date on which the form was last modified.
Description	Description of the MasterPM.
Description_Longdescription	Non-persistent attribute that specifies the Long description of the MasterPM.
ExtDate	Identifier of the date that overrides the PM's usual next due date for generating PM work orders. This date only applies to the current PM record; it does not apply to other PMs in a PM hierarchy. If the PM has an extension date, MAXIMO ignores the dates in the Active Season fields. MAXIMO always clears the Extended Date and Adjust Next Due Date fields after you generate work orders from this PM. If there is a value in this field, the Adjust Next Due Date? field is required. If there is no value in this field, the Adjust Next Due Date field is NULL and readonly.
Frequency	Identifies the number of time units to elapse between the workorders generated from PM. The time units can be Days,Weeks, Months or Years.
FreqUnit	The time units for the frequency attribute.
Friday	A boolean field that indicates whether friday is active work day.
Interruptible	A boolean field that indicates whether work orders generated by this PM can be interrupted or not when they are in progress. This information will be copied from the first jobplan in the sequence on this PM.
Itemnum	Unique identifier for this piece of rotating item.
ItemSet	ItemSetID	Identifier of the itemset identifier for this object.
LDKey	Long Description Key. This is a link to text stored in the LongDescription table.
LeadTime	Identifies the number of days in advance of the next due date when this PM generates the work orders.
LeadTimeActive	Non-persistent attribute that specifies whether LeadTime can be applied to PM for generating the work orders.
Itemnum	Identifies the Item number of the Rotating Item associated with master PM.
NextDate	The date on which the next work order will be generated by this PM.
MasterPMNum	Identifier for the MasterPM record.
MasterPMId	Unique Identifier for the MasterPM record.
Monday	A boolean field that indicates whether it is a active work day.
Prioritytd>Identifies the priority level used by the system when scheduling the work orders generated from this PM. If the priority in the MASTERPM table is NULL then the priority in the PM table should be based on the PM's Asset/Location.
SeasonEndDay	The end day of active season for a PM.
Saturday	A boolean field that indicates whether it is a active work day.
Sunday	A boolean field that indicates whether it is a active work day.
Thursday	A boolean field that indicates whether it is a active work day.
Tuesday	A boolean field that indicates whether it is a active work day.
UpdExtDate	A boolean field that indicates whether the Master PM updates extended date and adjust next due date fields on the associated PM records or not.
UpdSeasonalDates	A boolean field that indicates whether the Master PM updates seasonal date fields (start month, start day, end month and end day) on the associated PM records or not.
UpdTimeBasedFreq	A boolean field that indicates whether the Master PM updates the time based fields on the associated PM records or not.
UseFrequency	A boolean field that indicates whether this PM has frequency criteria to decide the next work order generation date.
UseTargetDate	A boolean field that indicates which date begins the PM Frequency Count. If this is set to 'True', the measurement of time between the work order generation from thisPM will begin at 'LastStartDate'. If this is 'false',the measurement will begin at 'LastCompDate'.
Wednesday	A boolean field that indicates whether it is a active work day.
WorkType	Type of the work order that will be generated from a PM.
WoStatus	The status of the work orders generated by the PM.

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
MasterPM(MboSet ms) Construct the MasterPM object

Method Summary

Modifier and Type	Method and Description
void	add() Sets default values for a new MasterPM object.
void	appValidate() This method will be called just before save() in order to make sure it is a valid MASTERPM record.
void	canDelete() Method that checks whether a MasterPM can be deleted or not.
void	createAssociatedPMs(MboSetRemote assetSet, MboSetRemote locSet) creates Associated PM's from a Master PM
void	delete(long modifier) Deletes a MasterPM record.
MboRemote	duplicate() This method creates a duplicate record for MasterPM and related objects (MasterPMMeter, MasterPMSequence, MasterPMSeasons).
int	getOrgCount()
boolean	isNull(java.lang.String attributeName) Determines whether the attribute value identified by name within the current object is null.
boolean	isValidJPRevNum(java.lang.String jpNum, java.lang.String revNum) Checks if the jobplan is in a compatible status.
void	mockItemNum(boolean enableMocking) Enables this mbo to say that its "itemnum" value is never null.
void	modify() Called whenever a change is made to the attributes of a MBO.
boolean	plusCCheckPmXtDtNotNull(MboSetRemote siteSet) Checks if some associated PM's extend date is not null.
java.util.HashSet	plusCGetAssociatedPMs(MboSetRemote siteSet) Gets all Pms associated to the current MasterPM.
void	plusCUpdateAssociatedPMs(MboSetRemote siteSet) Add a new register to PLUSCPMEXTDATE table before the core updateAssociatedPMs process is called.
void	setupPMFromMaster(MboRemote pmMbo) Copy values from master PM to new PM.
void	updateAssociatedPMs(MboSetRemote siteSet) Following attributes of the associated PM's are updated/copied from Master PM if 'overridemasterupd' of associated PMs is set to false. if'updtimebasedfreq' of Master PM is set to true, 'frequency' and 'frequnit' are copied from Master PM to associated PM.
void	validateTimeBasedFreq(double frequency) Validate time based frequency based on the frequncy units provided

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, 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, getESId, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertOrgForSite, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboCtx, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, init, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, setEAuditFieldModified, setESId, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMboCtx, setMLValue, setModified, setModifiedForIntegrationOnly, setNewMbo, setNoSql, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, 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, undelete, 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, getMboSet, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, 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, 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, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

MasterPM

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

Construct the MasterPM object

Throws:

MXException

java.rmi.RemoteException

Method Detail

add

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

Sets default values for a new MasterPM object.

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

canDelete

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

Method that checks whether a MasterPM can be deleted or not.
PM can only be deleted if it is not refrenced in the PM objects

Overrides:

canDelete in class Mbo

Throws:

MXException - when a PM has a refernece to the MasterPM

java.rmi.RemoteException

delete

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

Deletes a MasterPM record.
when a Masterpm is deleted, all records in MASTERPMMETER AND MASTERPMSEQUENCE will also be deleted for that MASTERPMNUM

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

modifier - access modifier

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

modify

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

Called whenever a change is made to the attributes of a MBO. The programmer should override if interested in intercepting this event. An example of the use of this is to set the changeby/changedate of a Purchase order whenever one of the attributes is set. If an MXException is thrown from this routine, the change of value is rolled back, this provides a mechanism to abort any changes. Default behavior is to do nothing. This method has overrided the Mbo.modify() method.

Overrides:

modify in class Mbo

Throws:

MXException

java.rmi.RemoteException

appValidate

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

This method will be called just before save() in order to make sure it is a valid MASTERPM record.

Overrides:

appValidate in class Mbo

Throws:

MXException - If there is any error while coping to masterpmseq

java.rmi.RemoteException

duplicate

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

This method creates a duplicate record for MasterPM and related objects (MasterPMMeter, MasterPMSequence, MasterPMSeasons). The duplicated MasterPM's masterpmnum will be an autokeyed value or blank if the autokey is switched "off".

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Returns:

MboRemote The newly duplicated PM

Throws:

MXException

java.rmi.RemoteException

createAssociatedPMs

public void createAssociatedPMs(MboSetRemote assetSet,
                                MboSetRemote locSet)
                         throws MXException,
                                java.rmi.RemoteException

creates Associated PM's from a Master PM

Specified by:

createAssociatedPMs in interface MasterPMRemote

Parameters:

MboSetRemote - AssetSet

MboSetRemote - LocationSet

Throws:

MXException

java.rmi.RemoteException

See Also:

createAssociatedPMs(MboSetRemote assetSet, MboSetRemote locSet)

setupPMFromMaster

public void setupPMFromMaster(MboRemote pmMbo)
                       throws MXException,
                              java.rmi.RemoteException

Copy values from master PM to new PM.

Specified by:

setupPMFromMaster in interface MasterPMRemote

Parameters:

pmMbo - The PM from where the values are copied.

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.masterpm.PM#setupPMFromMaster(MboRemote pmMbo)

getOrgCount

public int getOrgCount()
                throws MXException,
                       java.rmi.RemoteException

Specified by:

getOrgCount in interface MasterPMRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.masterpm.PM#getOrgCount()

updateAssociatedPMs

public void updateAssociatedPMs(MboSetRemote siteSet)
                         throws MXException,
                                java.rmi.RemoteException

Following attributes of the associated PM's are updated/copied from Master PM if 'overridemasterupd' of associated PMs is set to false.

if'updtimebasedfreq' of Master PM is set to true, 'frequency' and 'frequnit' are copied from Master PM to associated PM.
if'updmeterbasedfreq' of Master PMMeter is set to true, 'meterfrequency' info is copied from Master PMMeter to associated PMMeter.
if'updseasonaldates' of Master PM is set to true, MasterPM Seasons is copied from Master PM to associated PM's PMSeasons
if'updextdate' of Master PM is set to true, 'extdate' and 'adjnextdue' is copied from Master PM to associated PM.
if'updjpsequence' of Master PM is set to true, the jobplan sequence of the Master PM is copied to associated PM.

Specified by:

updateAssociatedPMs in interface MasterPMRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

updateAssociatedPMs(MboSetRemote siteSet)

validateTimeBasedFreq

public void validateTimeBasedFreq(double frequency)
                           throws MXException,
                                  java.rmi.RemoteException

Validate time based frequency based on the frequncy units provided

Throws:

MXException

java.rmi.RemoteException

plusCUpdateAssociatedPMs

public void plusCUpdateAssociatedPMs(MboSetRemote siteSet)
                              throws MXException,
                                     java.rmi.RemoteException

Add a new register to PLUSCPMEXTDATE table before the core updateAssociatedPMs process is called.

Specified by:

plusCUpdateAssociatedPMs in interface MasterPMRemote

Parameters:

siteSet -

Throws:

MXException

java.rmi.RemoteException

plusCCheckPmXtDtNotNull

public boolean plusCCheckPmXtDtNotNull(MboSetRemote siteSet)
                                throws MXException,
                                       java.rmi.RemoteException

Checks if some associated PM's extend date is not null.

Specified by:

plusCCheckPmXtDtNotNull in interface MasterPMRemote

Parameters:

siteSet -

Returns:

Throws:

MXException

java.rmi.RemoteException

plusCGetAssociatedPMs

public java.util.HashSet plusCGetAssociatedPMs(MboSetRemote siteSet)
                                        throws MXException,
                                               java.rmi.RemoteException

Gets all Pms associated to the current MasterPM.

Parameters:

siteSet -

Returns:

Throws:

MXException

java.rmi.RemoteException

mockItemNum

public void mockItemNum(boolean enableMocking)

Enables this mbo to say that its "itemnum" value is never null. The current scenario where it might take over is from its isNull(String attributeName) method

Parameters:

enableMocking - Flag to enable/disable such a feature

See Also:

psdi.plust.app.plusttmplt.virtual.PlusTPreviewGenAssetSet

isNull

public boolean isNull(java.lang.String attributeName)
               throws MXException,
                      java.rmi.RemoteException

Description copied from class: Mbo

Determines whether the attribute value identified by name within the current object is null. In order to handle the condition where the passed attributeName contains a . notation(for example, ASSET.DESCRIPTION when the current object is WorkOrder ), this method first gets the correct object and then checks if the attribute is null or not. If the attributeName does not contain a ".", the current object is assumed to be the one to retrieve information from.

Specified by:

isNull in interface MboRemote

Overrides:

isNull in class Mbo

Parameters:

attributeName - The attribute name within the current object.

Returns:

true if the attribute is currently null;false otherwise.

Throws:

MXException - "Attribute {0} does not exist" exception will be thrown if the attribute does not exist in the object.

java.rmi.RemoteException

See Also:

Mbo.isNull(String)

isValidJPRevNum

public boolean isValidJPRevNum(java.lang.String jpNum,
                               java.lang.String revNum)
                        throws MXException,
                               java.rmi.RemoteException

Checks if the jobplan is in a compatible status.

Parameters:

jpNum -

revNum -

Throws:

MXException

java.rmi.RemoteException