psdi.app.location

Class LocationMeter

java.lang.Object

psdi.mbo.Mbo

psdi.app.meter.DeployedMeter

psdi.app.location.LocationMeter

All Implemented Interfaces:

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

public class LocationMeter
extends DeployedMeter
implements LocationMeterRemote

MBO to represent a LocationMeter. See Location package description for details.

The key attributes for this object are as follows: SiteId, Location 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 location meter readings are used in the calculation. SLIDING-READINGS Last n* location meter readings are used in the calculation. SLIDING-DAYS Location Meter Readings from last n* days are used in the calculation. SLIDING-WEEKS Location Meter Readings from last n* weeks are used in the calculation. SLIDING-MONTHS Locatoin 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 LocationMeters that employ a STATIC AvgCalcMethod.
ChangeBy, ChangeDate	Name of the user who entered or last modified this LocationMeter and the date the LocationMeter 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 LocationMeter's children.
DomainId	Non-persistent attribute. For LocationMeters 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 LocationMeter's new reading roll the meter over. This attribute is READONLY when Rollover is null.
Active	Y/N field indicating whether or not the location's meter is available to accept readings.
Location	Location associated with the meter in this LocationMeter.
GroupName	Identifier of the meter group from which this meter was copied to this LocationMeter.
Inspector	Non-persistent attribute. Person who has provided the meter reading.
IsDelta	Non-persistent attribute. Is the meter reading being reported for this LocationMeter a delta value?
LastReading	Most recent reading for this LocationMeter.
LastReadingDate	Most recent reading date for this LocationMeter.
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 LocationMeter. 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 location in this LocationMeter.
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 LocationMeter.
PreviousReadingDate	Non-persistent attribute. Displays the most recent reading date for this LocationMeter.
PreviousReadingInspector	Non-persistent attribute. Displays the inspector for this LocationMeter's most recent reading.
Remarks	Additional information supplied by the user regarding the LocationMeter record. Long description enabled.
Rollover	Rollover value for this LocationMeter. If this LocationMeter has been created when applying a meter group to this location, the value defaults to the meter group's rollover value but can then be modified.
SinceInstall	Difference between the current meter reading for this LocationMeter's meter and the meter reading when this LocationMeter's location was moved into its current configuration.
SinceLastInspection	Difference between the current meter reading for this LocationMeter's meter and the meter reading when the last work order of type INSPECTION was opened or closed on this LocationMeter's location as determined by application setup.
SinceLastOverhaul	Difference between the current meter reading for this LocationMeter's meter and the meter reading when the last work order of type OVERHAUL was opened or closed on this LocationMeter's location as determined by application setup.
SinceLastRepair	Difference between the current meter reading for this LocationMeter's meter and the meter reading when the last work order was opened or closed on this LocationMeter's location 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.app.meter.DeployedMeter

app, avgCalcKey, coreAvgCalcSql, deployKey, earliestModifiedReading, enteringReplacementReading, isReadingUpdate, isWOMeterProcess, modifiedReadings, newMeterReading, origMRUpdate, readingTable, supressUniquenessError, woForWOMeter, woMeter_IdAttribute

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

Method Summary

Modifier and Type	Method and Description
void	delete(long accessModifier) Mark the object to be deleted depending on the access modifier.
protected java.lang.Object[]	getDeploymentInfo() provides key value and meter reading table name information for the LocationMeter ("location" and "locmeterreading")
MboSetRemote	getMboSet(java.lang.String name) Get a related MboSet for the object using the named relationship.
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
protected void	processContinuousReadings() processes the new or adjusted reading for the LocationMeter by adding a new meter reading (if the transaction is for a new reading) and updating this LocationMeter's meterreadings that are subsequent to the new reading or modification.
protected void	propagateNewLocMeterReadingToAssetsAtLoc(long meterreadingid) when a new location meter reading is entered for this LocationMeter, creates asset meterreadings for the AssetMeters of top-level assets at the location.
void	save() Check if process is being saved via Integration.

Methods inherited from class psdi.app.meter.DeployedMeter

add, addModifiedReadingsForAvgCalc, addReading, appValidate, canDelete, canDeleteForecast, enableDisable, enterReadingOnMaterialIssue, getAvgCalcMethod, getDenominator, getIsReadingUpdate, getIsWOMeterProcess, getMeterReadingForKnownDate, getNextMeterReading, getNumerator, getOrigMRUpdate, getPreviousMeterReading, getReadingType, getReadingValueAsDouble, getSkipAverageRefresh, getSkipDateUniquenessCheck, getSupressUniquenessErrorFlag, getTheMeter, getValidateOrder, handleAssetMeterLocMeterForWOEnterMeterReading, hasDeployedMeterApprReadingDeletion, init, isCurrentlyBeingAddedOnMeterGroupChange, isEnteringReplacementReading, isMeterReadingDateUnique, isNegativeAdjustment, isReadingMostRecentReading, maintainWOMeter, meterInGroupToDeployedMeter, meterInGroupToDeployedMeter, pmForecastExistsForMeterOnPM, processNonContinuousReadings, refreshAverage, refreshPreviousReadingInfo, resetMeter, returnDeploymentInfo, returnReadingForWOMeterProcessing, rolloverIsInProgress, setAdjustmentIsNegative, setCurrentlyBeingAddedOnMeterGroupChange, setIsReadingUpdate, setOrigMRUpdate, setPreviousReadingInfoOnInit, setSkipAverageRefresh, setSkipDateUniquenessCheck, setTypeSpecificFlags, undelete, validateALNEnteredDecimalValue, validateReading

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, deleteDoclinks, 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, getMboSetInfo, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRecordType, getRelatedSets, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getTenantIdForNoMboRecordData, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAppLockEnabled, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isDuringInit, 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, setDatabaseDefaultValues, setDatabaseDefaultValues, setDefaultValue, setDefaultValues, setDeleted, setDuringInit, 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, setRecordType, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setTenantIdForNoMboRecordData, 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, sigopGranted, sigOptionAccessAuthorized, skipCopyField, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, throwRequiredException, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undeleteDoclinks, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, 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, getPreviousMeterReading, getReadingType, getReadingValueAsDouble, getSkipAverageRefresh, getSupressUniquenessErrorFlag, getTheMeter, isCurrentlyBeingAddedOnMeterGroupChange, isNegativeAdjustment, isReadingMostRecentReading, maintainWOMeter, meterInGroupToDeployedMeter, meterInGroupToDeployedMeter, processNonContinuousReadings, refreshPreviousReadingInfo, resetMeter, returnDeploymentInfo, returnReadingForWOMeterProcessing, setAdjustmentIsNegative, setCurrentlyBeingAddedOnMeterGroupChange, setIsReadingUpdate, setOrigMRUpdate, setSkipAverageRefresh, setTypeSpecificFlags

Methods inherited from interface psdi.mbo.MboRemote

add, 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, 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, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

LocationMeter

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

Construct the LocationMeter object

Parameters:

ms - Mbo set

Throws:

MXException

java.rmi.RemoteException

Method Detail

getDeploymentInfo

protected java.lang.Object[] getDeploymentInfo()
                                        throws MXException,
                                               java.rmi.RemoteException

provides key value and meter reading table name information for the LocationMeter ("location" and "locmeterreading")

Specified by:

getDeploymentInfo in class DeployedMeter

Returns:

Object[] holding the keyvalue "location" in Object[0], meter reading table name "locmeterreading" in Object[1] and average calculation key "location" for this subclass of DeployedMeter.

Throws:

MXException

java.rmi.RemoteException

See Also:

DeployedMeter.getDeploymentInfo(), DeployedMeter.init(), psdi.app.meter.DeployedMeter#getReadings()

processContinuousReadings

protected void processContinuousReadings()
                                  throws MXException,
                                         java.rmi.RemoteException

processes the new or adjusted reading for the LocationMeter by adding a new meter reading (if the transaction is for a new reading) and updating this LocationMeter's meterreadings that are subsequent to the new reading or modification.

Specified by:

processContinuousReadings in class DeployedMeter

Throws:

MXException

java.rmi.RemoteException

See Also:

LocationMeter.getReadings(), #LocMeterReadingSet.updateReadingsAfterReadingUpdate(), #LocMeterReadingSet.updateReadingsAfterNewReading()

propagateNewLocMeterReadingToAssetsAtLoc

protected void propagateNewLocMeterReadingToAssetsAtLoc(long meterreadingid)
                                                 throws MXException,
                                                        java.rmi.RemoteException

when a new location meter reading is entered for this LocationMeter, creates asset meterreadings for the AssetMeters of top-level assets at the location. The AssetMeters for each asset must meet the following criteria:

• Active attribute must be true
• RollDownSource must be LOCATION
• MeterName attribute must be the same as this LocationMeter's MeterName

Parameters:

meterreadingid - locmeterreading's meterreadingid, used to set the MeterReading.LocMeterReadingId of any new asset meterreadings created here.

Throws:

MXException

java.rmi.RemoteException

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)

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

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

getMboSet

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

Description copied from class: Mbo

Get a related MboSet for the object using the named relationship. Used for cross object linking; for example,Work Order to Asset.

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)