psdi.app.meter

Class Meter

java.lang.Object

psdi.mbo.Mbo

psdi.app.meter.Meter

All Implemented Interfaces:

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

public class Meter
extends Mbo
implements MeterRemote

MBO to represent a Meter. See Meter package description for details.

The key attributes for this object are as follows: MeterName.

The attributes in this object are as follows:

Attribute Name	Description
Description	Description of this meter. Long description enabled.
DomainId	Identifier of the domain for a CHARACTERISTIC meter. The domain constrains this meter's value to be ALN or NUMERIC. The domain identifier cannot be null for a CHARACTERISTIC meter. This attribute must be null and is READONLY for the other meter types.
LDKey	Long Description Key. This is a link to text stored in the LongDescription table.
MeasureUnitId	unit of measure for this meter. For example, a meter that measures noise level might use decibels as a unit of measure. A meter that measures fuel consumption might use liters as a unit of measure. This attribute pertains only to meters of type CONTINUOUS and GAUGE.
MeterName	Identifier of this meter. A MeterName must be unique within each business unit.
MeterType	One of three possible values that describes how this meter's values are entered and interpreted. The three valid values are as follows: Meter Type Description Examples Where Used for Work Order Generation CONTINUOUS Continuous meters increment over time and/or usage. miles, hours, engine starts, pieces produced, fuel consumed Preventive Maintenance GAUGE Gauge meters monitor attributes that fluctuate within a range. The range is bound by upper and lower warning and action limits. temperature, pressure, noise level, oil level Condition Monitoring CHARACTERISTIC Characteristic meters are observational in nature. Valid values must belong to this meter's domain color Condition Monitoring
ReadingType	The default reading type for the meter. A reading type can be ACTUAL, that is, the total number of meter ticks registered, or DELTA, that is, the number of meter ticks since the last reading.

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

Method Summary

Modifier and Type	Method and Description
void	canDelete() This meter can be deleted if it does not exists in any of the following objects:
MboRemote	duplicate() Duplicates this Meter and its related objects.
void	generateAutoKey() Will Meter support autokeying????????????????/
java.lang.String	getMeterType() returns the internal, non-translated value for the MeterType attribute.
int	getTheScaleForReadings() IV78084: User may configure the actual readings to different scale.
void	init() Initialization rountine for this object.
boolean	isCharacteristic() Is this a characteristic meter?
boolean	isContinuous() Is this a continuous meter?
boolean	isContinuousOrGauge() Is this a continuous or gauge meter?
boolean	isGauge() Is this a gauge meter?
boolean	isGaugeOrCharacteristic() Is this a gauge or characteristic meter? That is, is this meter used to generate work orders via condition monitoring? A third type of meter, continuous, generates work orders via preventive maintenance.
protected void	setTypeSpecificFlags()
protected boolean	skipCopyField(MboValueInfo mvi) Overrides the skipCopyField() in the Mbo.

Methods inherited from class psdi.mbo.Mbo

add, addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, deleteDoclinks, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, fireEvent, 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, 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, getValidateOrder, 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, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, save, 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, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, throwRequiredException, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, 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.mbo.MboRemote

add, addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, 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, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Constructor Detail

Meter

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

Construct the Meter object

Parameters:

ms - Mbo set

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Initialization rountine for this object.

Overrides:

init in class Mbo

Throws:

MXException

setTypeSpecificFlags

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

Throws:

MXException

java.rmi.RemoteException

getMeterType

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

returns the internal, non-translated value for the MeterType attribute.

Specified by:

getMeterType in interface MeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

Meter.getMeterType()

isContinuous

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

Is this a continuous meter?

Specified by:

isContinuous in interface MeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

Meter.isContinuous()

isGauge

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

Is this a gauge meter?

Specified by:

isGauge in interface MeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

Meter.isGauge()

isCharacteristic

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

Is this a characteristic meter?

Specified by:

isCharacteristic in interface MeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

Meter.isCharacteristic()

isContinuousOrGauge

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

Is this a continuous or gauge meter?

Specified by:

isContinuousOrGauge in interface MeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

Meter.isContinuousOrGauge()

isGaugeOrCharacteristic

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

Is this a gauge or characteristic meter? That is, is this meter used to generate work orders via condition monitoring? A third type of meter, continuous, generates work orders via preventive maintenance.

Specified by:

isGaugeOrCharacteristic in interface MeterRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

Meter.isGaugeOrCharacteristic()

canDelete

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

This meter can be deleted if it does not exists in any of the following objects:

• Asset
• Location
• MeasurePoint
• PM (master PMs only)
• MeterInGroup

Overrides:

canDelete in class Mbo

Throws:

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

MXException

java.rmi.RemoteException

generateAutoKey

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

Will Meter support autokeying????????????????/

Specified by:

generateAutoKey in interface MboRemote

Overrides:

generateAutoKey in class Mbo

Throws:

java.rmi.RemoteException

MXException

See Also:

MboValue.autoKey(), MboValue.generateUniqueID()

duplicate

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

Duplicates this Meter and its related objects.

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Returns:

the newly duplicated MboRemote meter

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.mbo.Mbo#isAutoKeyed.

skipCopyField

protected boolean skipCopyField(MboValueInfo mvi)
                         throws java.rmi.RemoteException,
                                MXException

Overrides the skipCopyField() in the Mbo. Since this method takes the MboValueInfo as its parameter just check to see if this field needs to be copied or skipped by using the data from the static HashSet. If this field does not need to be copied return true. The following is/are Meter field(s) that will be skipped without being copied to the newly duplicated meter

• METERNAME

Overrides:

skipCopyField in class Mbo

Parameters:

The - MboValueInfo object of the MboValue that needs to be copied.

Returns:

True, if the field does not need to be copied. In all other cases, returns false.

Throws:

java.rmi.RemoteException

MXException

getTheScaleForReadings

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

IV78084: User may configure the actual readings to different scale. Get the actual scale, instead of the default 3.

Returns:

Throws:

MXException

java.rmi.RemoteException