psdi.app.asset

Class AssetMeter

java.lang.Object

psdi.mbo.Mbo

psdi.app.meter.DeployedMeter

psdi.app.asset.AssetMeter

All Implemented Interfaces:

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

public class AssetMeter
extends DeployedMeter
implements AssetMeterRemote

MBO to represent an AssetMeter. See Asset package description for details.

The key attributes for this object are as follows: SiteId, AssetNum and MeterName.

The attributes in this object are as follows:

Attribute Name	Description
AvgCalcMethod	Method used to calculate the average meter units per day upon entry of a new or modified meter reading. Valid values are as follows: Method Description STATIC Average is not recalculated - static value is stored in AvgCalcValue. ALL All previous meter readings are used in the calculation. SLIDING-READINGS Last n* meter readings are used in the calculation. SLIDING-DAYS Meter Readings from last n* days are used in the calculation. SLIDING-WEEKS Meter Readings from last n* weeks are used in the calculation. SLIDING-MONTHS Meter Readings from last n* months are used in the calculation. * n is a user-specified number
AvgMeterUnits	Non-persistent attribute. Holds the calculated average value. This value is dynamically calculated based on the AvgCalcMethod and the AvgCalcValue or SlidingWindowSize.
AvgCalcValue	average value for CONTINUOUS AssetMeters that employ a STATIC AvgCalcMethod.
ChangeBy, ChangeDate	Name of the user who entered or last modified this AssetMeter and the date the AssetMeter was entered or modified. These default to the system user name and date.
DeltaValue	Non-persistent attribute. This attribute, the value of which is calculated when a new reading is reported, is used to roll down the reading to this AssetMeter's children.
DomainId	Non-persistent attribute. For AssetMeters associated with CHARACTERISTIC meters only, this attribute holds domain information from the Meter. This domain information is used by NewReading and PreviousReading to look up and validate against the values in the ALNValue object.
DoRollover	Will this AssetMeter's new reading a roll the meter over. This attribute is READONLY when Rollover is null.
Active	Y/N field indicating whether or not the asset's meter is available to accept manual or rolled down readings, or to be used in PM or CM work order generation.
AssetNum	Asset associated with the meter in this AssetMeter.
GroupName	Identifier of the meter group from which this meter was copied to this AssetMeter.
InheritedFromAsset	Non-persistent attribute. Used to find additional readings in getAdditionalReadings() that may not have been part of a hierarchy at the time of a new reading or reading modification rolldown, but that may nevertheless need to be updated if they have become a child of one of the original AssetMeters during the rollforwad.
Inspector	Non-persistent attribute. Person who has provided the meter reading.
IsDelta	Non-persistent attribute. Is the meter reading being reported for this AssetMeter a delta value?
LastReading	Most recent reading for this AssetMeter.
LastReadingDate	Most recent reading date for this AssetMeter.
LDKey	Long description key for the Remarks attribute. This is a link to text stored in the LongDescription table.
LifeToDate	Total of all meter readings since the meter was manufactured. Reset only on replacement of physical meter.
MeasureUnitId	unit of measure for this AssetMeter. The value defaults to the meter's MeasureUnitId but can then be modified. This attribute pertains only to meters of type CONTINUOUS and GAUGE.
MeterName	Identifier of the meter associated with the asset in this AssetMeter.
NewReading	Non-persistent attribute. New meter reading value.
NewReadingDate	Non-persistent attribute. Date of the new meter reading value. This cannot be a future date.
PreviousReading	Non-persistent attribute. Displays the most recent reading for this AssetMeter.
PreviousReadingDate	Non-persistent attribute. Displays the most recent reading date for this AssetMeter.
Remarks	Additional information supplied by the user regarding the AssetMeter record. Long description enabled.
RolldownSource	Identifies whether or not a meter may accept reading deltas from a parent asset's or location's meter. Valid values are: ASSET accepts Asset rolldowns only. LOCATION accepts Location rolldowns only. NONE does not accept rolldowns If this attribute specifies ASSET or LOCATION, Active is 'Y' and this AssetMeter's meter name is the same as the parent's meter name, then this asset's meter reading is increased by the same amount.
Rollover	Rollover value for this AssetMeter. If this AssetMeter has been created when applying a meter group to this asset, the value defaults to the meter group's rollover value but can then be modified.
SinceInstall	Difference between the current meter reading for this AssetMeter's meter and the meter reading when this AssetMeter's asset was moved into its current configuration.
SinceLastInspection	Difference between the current meter reading for this AssetMeter's meter and the meter reading when the last work order of type INSPECTION was opened or closed on this AssetMeter's asset as determined by application setup.
SinceLastOverhaul	Difference between the current meter reading for this AssetMeter's meter and the meter reading when the last work order of type OVERHAUL was opened or closed on this AssetMeter's asset as determined by application setup.
SinceLastRepair	Difference between the current meter reading for this AssetMeter's meter and the meter reading when the last work order was opened or closed on this AssetMeter's asset as determined by application setup.
SlidingWindowSize	if the AvgCalcMethod employs a sliding scale, this attribute specifies the number of readings, days, weeks or months to use in the average calculation.

See Also:

psdi.app.meter.metergroup, psdi.app.meter.meteringroup

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

Method Summary

Modifier and Type	Method and Description
void	add() on add, sets values specific to this AssetMeter instance of a DeployedMeter, for example, the non-persistent AssetID.
void	addAdjustedDeltaForRollDownId(java.lang.String rollId, java.lang.String value) adds adjusted deltas for a rolldownid in FldMeterReadingDelta when a delta is modified on a reading with a ReadingSource of ENTERED, that is, a reading that has not been INHERITED.
void	appValidate() Issue#08-13711 If the MeterType is "CONTINUOUS" then Asset-Meter needs StartMeasure and EndMeasure
MboRemote	copy(MboSetRemote mboset, long mboAddFlags) Adds a new mbo to the set passed in and copies the information for each of the fields into the new mbo from this.
void	delete(long accessModifier) Mark the object to be deleted depending on the access modifier.
MboRemote	getPreviousMeterReading(java.util.Date previousToDate) gets the meter reading (for an AssetMeter whose meter is of type CONTINUOUS) or measurement (for a AssetMeter 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.
void	init() initialization routine for this object.
boolean	isChangeByUserWhenSetFromLookup(java.lang.String lookupAttrName, java.lang.String attributeName) Indicate whether the changeed by user flag should be set to the attribute when it is set along with other key field when the lookup attribute is being set on this Linear Mbo.
void	isOwningMboNOSAVE() 10-19707: the modify() method sets the owner(most likely Location) isModified flag to true.
void	modify() called whenever a field is modified to update the changedate and changeby attributes
void	save() Check if process is being saved via Integration.
void	setTypeSpecificFlags() sets meter type-specific field flags that are also specific to the AssetMeter object

Methods inherited from class psdi.app.meter.DeployedMeter

addModifiedReadingsForAvgCalc, addReading, canDelete, canDeleteForecast, enableDisable, enterReadingOnMaterialIssue, getAvgCalcMethod, getIsReadingUpdate, getIsWOMeterProcess, getMeterReadingForKnownDate, getNextMeterReading, getOrigMRUpdate, getReadingType, getReadingValueAsDouble, getSkipAverageRefresh, getSupressUniquenessErrorFlag, getTheMeter, getValidateOrder, isCurrentlyBeingAddedOnMeterGroupChange, isNegativeAdjustment, isReadingMostRecentReading, maintainWOMeter, meterInGroupToDeployedMeter, meterInGroupToDeployedMeter, pmForecastExistsForMeterOnPM, processNonContinuousReadings, refreshPreviousReadingInfo, resetMeter, returnDeploymentInfo, returnReadingForWOMeterProcessing, setAdjustmentIsNegative, setCurrentlyBeingAddedOnMeterGroupChange, setIsReadingUpdate, setOrigMRUpdate, setPreviousReadingInfoOnInit, setSkipAverageRefresh, undelete, validateALNEnteredDecimalValue

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, 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, 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.app.meter.DeployedMeterRemote

addModifiedReadingsForAvgCalc, addReading, enableDisable, enterReadingOnMaterialIssue, getAvgCalcMethod, getIsReadingUpdate, getIsWOMeterProcess, getMeterReadingForKnownDate, getOrigMRUpdate, getReadingType, getReadingValueAsDouble, getSkipAverageRefresh, getSupressUniquenessErrorFlag, getTheMeter, isCurrentlyBeingAddedOnMeterGroupChange, isNegativeAdjustment, isReadingMostRecentReading, maintainWOMeter, meterInGroupToDeployedMeter, meterInGroupToDeployedMeter, processNonContinuousReadings, refreshPreviousReadingInfo, resetMeter, returnDeploymentInfo, returnReadingForWOMeterProcessing, setAdjustmentIsNegative, setCurrentlyBeingAddedOnMeterGroupChange, setIsReadingUpdate, setOrigMRUpdate, setSkipAverageRefresh

Methods inherited from interface psdi.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, 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, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

AssetMeter

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

Construct the AssetMeter object

Parameters:

ms - Mbo set

Throws:

MXException

java.rmi.RemoteException

Method Detail

addAdjustedDeltaForRollDownId

public void addAdjustedDeltaForRollDownId(java.lang.String rollId,
                                          java.lang.String value)
                                   throws MXException,
                                          java.rmi.RemoteException

adds adjusted deltas for a rolldownid in FldMeterReadingDelta when a delta is modified on a reading with a ReadingSource of ENTERED, that is, a reading that has not been INHERITED.

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

setTypeSpecificFlags

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

sets meter type-specific field flags that are also specific to the AssetMeter object

Specified by:

setTypeSpecificFlags in interface DeployedMeterRemote

Overrides:

setTypeSpecificFlags in class DeployedMeter

Throws:

MXException

java.rmi.RemoteException

See Also:

init, FldAssetMeterMeterName, FldDeployedMeterAvgCalcMethod

isChangeByUserWhenSetFromLookup

public boolean isChangeByUserWhenSetFromLookup(java.lang.String lookupAttrName,
                                               java.lang.String attributeName)

Indicate whether the changeed by user flag should be set to the attribute when it is set along with other key field when the lookup attribute is being set on this Linear Mbo.

Overrides:

isChangeByUserWhenSetFromLookup in class Mbo

Parameters:

lookupAttrName - the attribute whose lookup is being called.

attributeName - the attribute that is not the lookup attribute.

Returns:

init

public void init()
          throws MXException

Description copied from class: DeployedMeter

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 DeployedMeter

Throws:

MXException

appValidate

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

Issue#08-13711 If the MeterType is "CONTINUOUS" then Asset-Meter needs StartMeasure and EndMeasure

Overrides:

appValidate in class DeployedMeter

Throws:

MXException

java.rmi.RemoteException

add

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

on add, sets values specific to this AssetMeter instance of a DeployedMeter, for example, the non-persistent AssetID.

Specified by:

add in interface MboRemote

Overrides:

add in class DeployedMeter

Throws:

MXException

java.rmi.RemoteException

getPreviousMeterReading

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

gets the meter reading (for an AssetMeter whose meter is of type CONTINUOUS) or measurement (for a AssetMeter 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

Overrides:

getPreviousMeterReading in class DeployedMeter

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:

DeployedMeter.refreshPreviousReadingInfo(Date previousToDate)

modify

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

Description copied from class: DeployedMeter

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

Overrides:

modify in class DeployedMeter

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 DeployedMeter

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)

save

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

Check if process is being saved via Integration. Call the autoWogen method to generate work orders if needed.

Overrides:

save in class DeployedMeter

Throws:

MXException

java.rmi.RemoteException

See Also:

enterNewReading, updateCumulatives

isOwningMboNOSAVE

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

10-19707: the modify() method sets the owner(most likely Location) isModified flag to true. However if the user does not have the secrutiy for SAVE of the application where MAINMBO is the owning object, the location object should not be updated. This applies to enter Meter Reading - per the product designer we should allow meter readings to be saved while not saving the location if the user group has only READ but no SAVE security for the application

Throws:

MXException

java.rmi.RemoteException

copy

public MboRemote copy(MboSetRemote mboset,
                      long mboAddFlags)
               throws MXException,
                      java.rmi.RemoteException

Description copied from class: Mbo

Adds a new mbo to the set passed in and copies the information for each of the fields into the new mbo from this. The new mbo will be added to the next of the current index.

Specified by:

copy in interface MboRemote

Overrides:

copy in class Mbo

Parameters:

mboset - The set into which the new mbo will be added.

mboAddFlags - Flags to use when adding the new Mbo. Values on the attribute are always set with NOACCESSCHECK|NOVALIDATION_AND_NOACTION.

Returns:

The new mbo, with values copied from this mbo.

Throws:

MXException

java.rmi.RemoteException