psdi.app.meter

Class DeployedMeter

java.lang.Object

psdi.mbo.Mbo

psdi.app.meter.DeployedMeter

All Implemented Interfaces:

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

Direct Known Subclasses:

AssetMeter, LocationMeter

public abstract class DeployedMeter
extends Mbo
implements DeployedMeterRemote

This abstract class provides common methods for AssetMeter and LocationMeter, referred to herein generically as DeployedMeter

See Meter Package description.

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
DeployedMeter(MboSet ms) Constructs the DeployedMeter object.

Method Summary

Modifier and Type	Method and Description
void	add() adds a new DeployedMeter object and sets field defaults.
void	addModifiedReadingsForAvgCalc(MboRemote reading) adds modified readings to be used to refresh the average reading for the DeployedMeter following a new meter reading or meter reading update.
MboRemote	addReading() adds a new reading for the DeployedMeter
void	appValidate() validates context-sensitive attributes AvgCalcInfo and AvgCalcMethod.
void	canDelete() This DeployedMeter can be deleted if it does not exist in any of the following objects:
boolean	canDeleteForecast(java.lang.String message)
void	delete(long accessModifier) Mark the object to be deleted depending on the access modifier.
void	enableDisable() sets read/writeability of non-persistent attributes listed below based on the status of the DeployedMeter's Active attribute.
boolean	enterReadingOnMaterialIssue() called from an owning and new MatUseTrans object of IssueType ISSUE to record a meter reading when the item being issued is NOT rotating, has a metername and is being issued to an Asset or Location, and the Asset or Location has an AssetMeter or LocationMeter with a metername that corresponds to the issued item's metername.
java.lang.String	getAvgCalcMethod() returns the internal translation of the AvgCalcMethod value from the AVERAGEMETHOD domain.
boolean	getIsReadingUpdate() gets the yes/no flag that tells whether this DeployedMeter has been instanciated while rolling a reading update down the hierarchy and forward through each DeployedMeter's meter reading history.
boolean	getIsWOMeterProcess() gets the yes/no flag that tells whether this DeployedMeter has been instanciated while processing a WOMeter reading.
MboRemote	getMeterReadingForKnownDate(java.util.Date dt) returns Reading object for date provided
MboRemote	getNextMeterReading(java.util.Date followingDate)
Mbo	getOrigMRUpdate()
MboRemote	getPreviousMeterReading(java.util.Date previousToDate) gets the meter reading (for a DeployedMeter whose meter is of type CONTINUOUS) or measurement (for a DeployedMeter whose meter is of type CHARACTERISTIC or GAUGE) that immediately precedes one of the following: meter reading/measurement being entered or updated for the DeployedMeter if meterreading activity is taking place current date/time, to get the last, that is, most recent reading taken for the DeployedMeter.
java.lang.String	getReadingType() returns the internal translation of the ReadingType value from the READINGTYPE domain.
double	getReadingValueAsDouble(java.util.Date dt) gets numeric (that is, GAUGE or CHARACTERISTIC) reading for a particular date.
boolean	getSkipAverageRefresh()
boolean	getSupressUniquenessErrorFlag() returns the supressUniquenessError flag
MeterRemote	getTheMeter()
java.lang.String[]	getValidateOrder() Validation Order for DeployedMeter attributes.
void	init() initialization routine for this object.
boolean	isCurrentlyBeingAddedOnMeterGroupChange()
boolean	isNegativeAdjustment()
boolean	isReadingMostRecentReading(java.util.Date readingDate) determines whether this DeployedMeter's LastReading and LastReadingDate attributes need to be updated.
void	maintainWOMeter(MboRemote reading) adds a new WOMeter and sets the measurementid, meterreadingid or locmeterreadingid depending what kind of MBO the measurement/reading is, that is, Measurement, MeterReading or LocMeterReading.
void	meterInGroupToDeployedMeter(MeterInGroupRemote meter, boolean supressUniquenessError) sets meter-specific attributes for this DeployedMeter object from the passed in meter
void	meterInGroupToDeployedMeter(MeterInGroupRemote meter, boolean supressUniquenessError, boolean supressDupSeqNumWarning) sets meter-specific attributes for this DeployedMeter object from the passed in meter
void	modify() called whenever a field is modified to update the changedate and changeby attributes
boolean	pmForecastExistsForMeterOnPM() Determines if this asset meter is used on a PM that has a forecast.
void	processNonContinuousReadings() adds a new measurement for a meter of type GAUGE or CHARACTERISTIC
void	refreshPreviousReadingInfo(java.util.Date previousToDate) gets the previous meter reading and uses it to set the following non-persistent attributes: PreviousReading PreviousReadingDate PreviousReadingInspector
void	resetMeter() resets the following DeployedMeter attributes: SINCELASTREPAIR SINCELASTOVERHAUL SINCELASTINSPECT SINCEINSTALL ROLLOVER
java.lang.Object[]	returnDeploymentInfo() returns key value and meter reading table name information for the DeployedMeter's instanciated subclass, for example, an AssetMeter ("assetnum" and "meterreading") or LocationMeter ("location" and "locmeterreading").
MboRemote	returnReadingForWOMeterProcessing() returns reading to use for creation of a WOMeter when processing a WOMeter.
void	save() begins the process of entering a new meterreading object and/or rolling updates to an existing meterreading object down the hierarchy to LocationMeters that belong to children asset of this LocationMeter's asset and forward to other subsequent readings already recorded for this LocationMeter.
void	setAdjustmentIsNegative(boolean adjustmentIsNegative)
void	setCurrentlyBeingAddedOnMeterGroupChange(boolean currentlyBeingAddedOnMeterGroupChange)
void	setIsReadingUpdate(boolean isUpdate) sets to true the yes/no flag that tells whether this DeployedMeter been instanciated while rolling a reading update down the hierarchy and forward through each DeployedMeter's meter reading history.
void	setOrigMRUpdate(Mbo origMRUpdate) sets origMRUpdate with the meter reading whose update began 'Update Meter History' processing
void	setPreviousReadingInfoOnInit()
void	setSkipAverageRefresh(boolean actReadInUpdateRangeAfterNewRead)
void	setTypeSpecificFlags() sets meter type-specific field flags
void	undelete() Unmark the Mbo for deletion.
void	validateALNEnteredDecimalValue(java.lang.String readingAttribute)

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, duplicate, 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, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, 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, 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, duplicate, 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, 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

DeployedMeter

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

Constructs the DeployedMeter object.

Throws:

MXException

java.rmi.RemoteException

Method Detail

isNegativeAdjustment

public boolean isNegativeAdjustment()

Specified by:

isNegativeAdjustment in interface DeployedMeterRemote

setAdjustmentIsNegative

public void setAdjustmentIsNegative(boolean adjustmentIsNegative)

Specified by:

setAdjustmentIsNegative in interface DeployedMeterRemote

modify

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

called whenever a field is modified to update the changedate and changeby attributes

Overrides:

modify in class Mbo

Throws:

MXException

java.rmi.RemoteException

addModifiedReadingsForAvgCalc

public void addModifiedReadingsForAvgCalc(MboRemote reading)
                                   throws MXException,
                                          java.rmi.RemoteException

adds modified readings to be used to refresh the average reading for the DeployedMeter following a new meter reading or meter reading update. This is necessary because the average calculation takes place by querying the database before the modified readings have been saved to the database. Subsequently, when the average calculation is taking place, the modifiedReadings Hashtable is first checked for each Reading object. If modifiedReadings contains a Reading's meterreading, it is used in the calculation instead of the "dirty" Reading just queried from the database. This method also sets earliestModifiedReading equal to the new reading, if earliestModifiedReading is null or has a readingdate later than the new reading's readigdate.

Specified by:

addModifiedReadingsForAvgCalc in interface DeployedMeterRemote

Parameters:

rollId - key for a new entry in the adjustedDeltas hashtable.

value - adjusted delta value for a new entry in the adjustedDeltas hashtable.

Throws:

MXException

java.rmi.RemoteException

See Also:

addModifiedReadingsForAvgCalc(MboRemote reading)

getOrigMRUpdate

public Mbo getOrigMRUpdate()
                    throws MXException,
                           java.rmi.RemoteException

Specified by:

getOrigMRUpdate in interface DeployedMeterRemote

Returns:

origMRUpdate MBO of the meter reading whose update began 'Update Meter History' processing

Throws:

MXException

java.rmi.RemoteException

See Also:

getOrigMRUpdate()

setOrigMRUpdate

public void setOrigMRUpdate(Mbo origMRUpdate)
                     throws MXException,
                            java.rmi.RemoteException

sets origMRUpdate with the meter reading whose update began 'Update Meter History' processing

Specified by:

setOrigMRUpdate in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.asset.MeterReading.save(), psdi.app.location.LocMeterReading.save()

returnDeploymentInfo

public java.lang.Object[] returnDeploymentInfo()
                                        throws MXException,
                                               java.rmi.RemoteException

returns key value and meter reading table name information for the DeployedMeter's instanciated subclass, for example, an AssetMeter ("assetnum" and "meterreading") or LocationMeter ("location" and "locmeterreading").

Specified by:

returnDeploymentInfo in interface DeployedMeterRemote

Returns:

Object[] holding the keyvalue in Object[0] and meter reading table name in Object[1] for the instanciated subclass of this DeployedMeter

Throws:

MXException

java.rmi.RemoteException

See Also:

getDeploymentInfo()

isReadingMostRecentReading

public boolean isReadingMostRecentReading(java.util.Date readingDate)
                                   throws MXException,
                                          java.rmi.RemoteException

determines whether this DeployedMeter's LastReading and LastReadingDate attributes need to be updated. If the reading being added is more recent or the reading being modified is the same reading as the LastReading, then the updates will occur. In the case of an update, just the LastReading attribute will be modified.

Specified by:

isReadingMostRecentReading in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

isReadingMostRecentReading(Date readingDate)

setIsReadingUpdate

public void setIsReadingUpdate(boolean isUpdate)
                        throws MXException,
                               java.rmi.RemoteException

sets to true the yes/no flag that tells whether this DeployedMeter been instanciated while rolling a reading update down the hierarchy and forward through each DeployedMeter's meter reading history. This method should not be called for updates resulting from a new reading - it is specifically for rolling a pure update to an already-existing Reading.

Specified by:

setIsReadingUpdate in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

setIsReadingUpdate(boolean isUpdate)

getIsReadingUpdate

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

gets the yes/no flag that tells whether this DeployedMeter has been instanciated while rolling a reading update down the hierarchy and forward through each DeployedMeter's meter reading history.

Specified by:

getIsReadingUpdate in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getIsReadingUpdate()

getIsWOMeterProcess

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

gets the yes/no flag that tells whether this DeployedMeter has been instanciated while processing a WOMeter reading.

Specified by:

getIsWOMeterProcess in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getIsWOMeterProcess()

getSupressUniquenessErrorFlag

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

returns the supressUniquenessError flag

Specified by:

getSupressUniquenessErrorFlag in interface DeployedMeterRemote

Returns:

supressUniquenessError if true, system duplicatekey error will not be thrown as new DeployedMeters are being generated behind the scenes after adding a new Meter to a MeterGroup, or after modifying a DeployedMeter's owner's GroupName attribute.

Throws:

MXException

java.rmi.RemoteException

See Also:

MeterService's meterUniqueToSet(), meterInGroupToAssetMeter(MeterInGroupRemote meter,boolean supressUniquenessError).

getNextMeterReading

public MboRemote getNextMeterReading(java.util.Date followingDate)
                              throws MXException,
                                     java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

add

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

adds a new DeployedMeter object and sets field defaults.

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

This DeployedMeter can be deleted if it does not exist in any of the following objects:

• MeterReading (for AssetMeter)
• LocMeterReading (for LocationMeter)
• MeasurePoint

Overrides:

canDelete in class Mbo

Throws:

MXApplicationException - ("meter","existsintable") when referenced by another object.

MXException

java.rmi.RemoteException

canDeleteForecast

public boolean canDeleteForecast(java.lang.String message)
                          throws MXException,
                                 java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

delete

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

Description copied from class: Mbo

Mark the object to be deleted depending on the access modifier. This will usually be overridden in the subclass of Mbo as there may be application specific rules as to if and when an object can be deleted. Object is not actually deleted in the database until save() is called. This method will also mark all associated Long Description and Translation Mbos for deletion.

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:

Mbo.delete(long)

undelete

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

Description copied from class: Mbo

Unmark the Mbo for deletion. Can only be called after a delete() and before the save() has been performed. This method will also unmark associated Long Description and Translation Mbos.

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

meterInGroupToDeployedMeter

public void meterInGroupToDeployedMeter(MeterInGroupRemote meter,
                                        boolean supressUniquenessError)
                                 throws MXException,
                                        java.rmi.RemoteException

sets meter-specific attributes for this DeployedMeter object from the passed in meter

Specified by:

meterInGroupToDeployedMeter in interface DeployedMeterRemote

Parameters:

meter - MeterInGroupRemote object used to set meter-specific attributes

supressUniquenessError - if DeployedMeter is being added from MeterInGroup via the PropagateMeterGroupMod functionality, or if DeployedMeter is being added as a result of the DeployedMeter's parent's GroupName attribute getting a value, supress the system's duplicatekey error

Throws:

MXException

java.rmi.RemoteException

See Also:

meterInGroupToDeployedMeter(MeterInGroupRemote meter,boolean supressUniquenessError)

isCurrentlyBeingAddedOnMeterGroupChange

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

Specified by:

isCurrentlyBeingAddedOnMeterGroupChange in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

isCurrentlyBeingAddedOnMeterGroupChange()

setCurrentlyBeingAddedOnMeterGroupChange

public void setCurrentlyBeingAddedOnMeterGroupChange(boolean currentlyBeingAddedOnMeterGroupChange)
                                              throws MXException,
                                                     java.rmi.RemoteException

Specified by:

setCurrentlyBeingAddedOnMeterGroupChange in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

setCurrentlyBeingAddedOnMeterGroupChange(boolean currentlyBeingAddedOnMeterGroupChange)

meterInGroupToDeployedMeter

public void meterInGroupToDeployedMeter(MeterInGroupRemote meter,
                                        boolean supressUniquenessError,
                                        boolean supressDupSeqNumWarning)
                                 throws MXException,
                                        java.rmi.RemoteException

sets meter-specific attributes for this DeployedMeter object from the passed in meter

Specified by:

meterInGroupToDeployedMeter in interface DeployedMeterRemote

Parameters:

meter - MeterInGroupRemote object used to set meter-specific attributes

supressUniquenessError - if DeployedMeter is being added from MeterInGroup via the PropagateMeterGroupMod functionality, or if DeployedMeter is being added as a result of the DeployedMeter's parent's GroupName attribute getting a value, supress the system's duplicatekey error

supressDupSeqNumWarning - user has chosen to add a new meter to a group with a duplicate sequence. Assume that it is OK to duplicate the sequence number on assets and locations that have this meter group.

Throws:

MXException

java.rmi.RemoteException

See Also:

meterInGroupToDeployedMeter(MeterInGroupRemote meter,boolean supressUniquenessError,boolean supressDupSeqNumWarning)

init

public void init()
          throws MXException

initialization routine for this object. In addition to setting field flags, DeployedMeter's init sets the information needed from the last reading, and calculates the non-persistent AvgMeterUnits value.

Overrides:

init in class Mbo

Throws:

MXException

getAvgCalcMethod

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

returns the internal translation of the AvgCalcMethod value from the AVERAGEMETHOD domain.

Specified by:

getAvgCalcMethod in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getAvgCalcMethod()

getReadingType

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

returns the internal translation of the ReadingType value from the READINGTYPE domain.

Specified by:

getReadingType in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getReadingType()

getTheMeter

public MeterRemote getTheMeter()
                        throws MXException,
                               java.rmi.RemoteException

Specified by:

getTheMeter in interface DeployedMeterRemote

Returns:

the Meter object associated with this DeployedMeter

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.meter.DeployedMeter#isAReadingUpdate()

setSkipAverageRefresh

public void setSkipAverageRefresh(boolean actReadInUpdateRangeAfterNewRead)
                           throws MXException,
                                  java.rmi.RemoteException

Specified by:

setSkipAverageRefresh in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

setSkipAverageRefresh(boolean)

getSkipAverageRefresh

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

Specified by:

getSkipAverageRefresh in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getSkipAverageRefresh()

setTypeSpecificFlags

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

sets meter type-specific field flags

Specified by:

setTypeSpecificFlags in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

init, FldAssetMeterMeterName, FldAssetMeterAvgCalcMethod

enableDisable

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

sets read/writeability of non-persistent attributes listed below based on the status of the DeployedMeter's Active attribute. Also check user's security profile to see if the user is authorized to enter new readings, readings that will not be the most recent readings in the database, both, or neither of these. If the user is not authorized to enter either, then all the attributes are READONLY.

• PreviousReading
• PreviousReadingDate
• PreviousReadingInspector
• NewReading
• NewReadingDate
• IsDelta
• Inspector
• Remarks

Specified by:

enableDisable in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

checkEnterHistoryReadingAuth(), checkEnterNewReadingAuth(), init(), FldDeployedMeterActive.action()

refreshPreviousReadingInfo

public void refreshPreviousReadingInfo(java.util.Date previousToDate)
                                throws MXException,
                                       java.rmi.RemoteException

gets the previous meter reading and uses it to set the following non-persistent attributes:

• PreviousReading
• PreviousReadingDate
• PreviousReadingInspector

Also, if NewReadingDate has been set, then method checks to see if the new reading is a new historic reading.

Specified by:

refreshPreviousReadingInfo in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

refreshPreviousReadingInfo(Date)

getPreviousMeterReading

public MboRemote getPreviousMeterReading(java.util.Date previousToDate)
                                  throws MXException,
                                         java.rmi.RemoteException

gets the meter reading (for a DeployedMeter whose meter is of type CONTINUOUS) or measurement (for a DeployedMeter whose meter is of type CHARACTERISTIC or GAUGE) that immediately precedes one of the following:

• meter reading/measurement being entered or updated for the DeployedMeter if meterreading activity is taking place
• current date/time, to get the last, that is, most recent reading taken for the DeployedMeter.

Specified by:

getPreviousMeterReading in interface DeployedMeterRemote

Parameters:

previousToDate - date used to find the previous reading (that is,the reading that is older than but closest to the date)

Returns:

reading MBO

Throws:

MXException

java.rmi.RemoteException

See Also:

refreshPreviousReadingInfo(Date previousToDate)

getReadingValueAsDouble

public double getReadingValueAsDouble(java.util.Date dt)
                               throws MXException,
                                      java.rmi.RemoteException

gets numeric (that is, GAUGE or CHARACTERISTIC) reading for a particular date.

Specified by:

getReadingValueAsDouble in interface DeployedMeterRemote

Parameters:

dt -

Returns:

double reading value. If no reading exists for date provided, Double.NaN is returned.

Throws:

MXException

java.rmi.RemoteException

See Also:

getReadingValueAsDouble(Date)

getMeterReadingForKnownDate

public MboRemote getMeterReadingForKnownDate(java.util.Date dt)
                                      throws MXException,
                                             java.rmi.RemoteException

returns Reading object for date provided

Specified by:

getMeterReadingForKnownDate in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getMeterReadingForKnownDate(Date)

setPreviousReadingInfoOnInit

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

Throws:

MXException

java.rmi.RemoteException

getValidateOrder

public java.lang.String[] getValidateOrder()

Validation Order for DeployedMeter attributes. Those listed here will have precedence over those not listed here. The order of precedence goes from first in the list (highest precedence among listed attributes) to last (lowest precedence among listed attributes)
The list is:

1. METERNAME

Overrides:

getValidateOrder in class Mbo

appValidate

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

validates context-sensitive attributes AvgCalcInfo and AvgCalcMethod. When AvgCalcMethod is not equal to ALL and the meter type is CONTINUOUS, then AvgCalcInfo is required.

Overrides:

appValidate in class Mbo

Throws:

MXApplicationException - ("asset", "multiplier_null")

MXApplicationException - ("asset", "value_null")

MXException

java.rmi.RemoteException

processNonContinuousReadings

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

adds a new measurement for a meter of type GAUGE or CHARACTERISTIC

Specified by:

processNonContinuousReadings in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

addMeasurement(), AssetMeter.save(), LocationMeter.save(), LocationMeter.save(), FldWOMeasurementValue.action(), FldWOMeasureDate.action(), FldWOPointNum.action()

addReading

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

adds a new reading for the DeployedMeter

Specified by:

addReading in interface DeployedMeterRemote

Returns:

new Reading object

Throws:

MXException

java.rmi.RemoteException

See Also:

addReading()

maintainWOMeter

public void maintainWOMeter(MboRemote reading)
                     throws MXException,
                            java.rmi.RemoteException

adds a new WOMeter and sets the measurementid, meterreadingid or locmeterreadingid depending what kind of MBO the measurement/reading is, that is, Measurement, MeterReading or LocMeterReading.

Specified by:

maintainWOMeter in interface DeployedMeterRemote

Parameters:

reading - measurement/reading that is the basis for the new WOMeter

Throws:

MXException

java.rmi.RemoteException

See Also:

maintainWOMeter(MboRemote reading)

returnReadingForWOMeterProcessing

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

returns reading to use for creation of a WOMeter when processing a WOMeter. This reading will be a Measurement if the meter is of type GAUGE or CHARACTERISTIC. This reading will be a MeterReading (for an AssetMeter) or a LocMeterReading (for a LocationMeter) if the meter is of type CONTINUOUS. If the measurement/reading has already been added, the reading is not added again. Only a WOMeter is created based on the already-entered reading. If the measurement/reading has not already been added, then this will return null and a new Measurement, MeterReading or LocMeterReading will be added before adding the new WOMeter.

Specified by:

returnReadingForWOMeterProcessing in interface DeployedMeterRemote

Returns:

MboRemote Measurement,MeterReading or LocMeterReading that is being added by a work order. Returns null if the measurement/reading has not already been added (that is, a reading with the same date and value). The null return signals to the DeployedMeter that a new measurement/ reading needs to be added.

Throws:

MXException

java.rmi.RemoteException

See Also:

AssetMeter.save(), LocationMeter.save()

resetMeter

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

resets the following DeployedMeter attributes:

• SINCELASTREPAIR
• SINCELASTOVERHAUL
• SINCELASTINSPECT
• SINCEINSTALL
• ROLLOVER

Specified by:

resetMeter in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

resetMeter()

save

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

begins the process of entering a new meterreading object and/or rolling updates to an existing meterreading object down the hierarchy to LocationMeters that belong to children asset of this LocationMeter's asset and forward to other subsequent readings already recorded for this LocationMeter. LocationMeter cumulative attributes are then updated. These attributes are:

• SINCELASTREPAIR
• SINCELASTOVERHAUL
• SINCELASTINSPECT
• SINCEINSTALL
• LIFETODATE

Throws:

MXException

java.rmi.RemoteException

See Also:

enterNewReading, updateCumulatives

enterReadingOnMaterialIssue

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

called from an owning and new MatUseTrans object of IssueType ISSUE to record a meter reading when the item being issued is NOT rotating, has a metername and is being issued to an Asset or Location, and the Asset or Location has an AssetMeter or LocationMeter with a metername that corresponds to the issued item's metername.

Specified by:

enterReadingOnMaterialIssue in interface DeployedMeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

enterReadingOnMaterialIssue()

validateALNEnteredDecimalValue

public void validateALNEnteredDecimalValue(java.lang.String readingAttribute)
                                    throws MXException,
                                           java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

pmForecastExistsForMeterOnPM

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

Determines if this asset meter is used on a PM that has a forecast.

Throws:

MXException

java.rmi.RemoteException