psdi.app.meter

Class MeterGroup

  • All Implemented Interfaces:
    java.rmi.Remote, MeterGroupRemote, MboConstants, MboRemote, MaxRemoteProxy


    public class MeterGroup
    extends Mbo
    implements MeterGroupRemote
    MBO to represent a MeterGroup. See MeterGroup package description for details.

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

    The attributes in this object are as follows:

    Attribute NameDescription
    DescriptionDescription of this meter group. Long description enabled.
    GroupNameIdentifier of this meter group. A MeterGroup must be unique within each financial entity.
    LDKeyLong Description Key. This is a link to text stored in the LongDescription table.
    PropagateModNon-persistent attribute. Used to indicate whether to propagate additions to this meter group to all assets and items associated with it. This attribute is copied to MeterInGroup.PropagateMeterGroupMod on MeterGroup.add().
    See Also:
    psdi.app.meter.meter, psdi.app.meter.meteringroup
    • Constructor Detail

      • MeterGroup

        public MeterGroup(MboSet ms)
                   throws MXException,
                          java.rmi.RemoteException
        Construct the MeterGroup object
        Parameters:
        ms - Mbo set
        Throws:
        MXException
        java.rmi.RemoteException
    • Method Detail

      • getAdditionalRequiredAssetMeterAttrs

        public java.util.Hashtable getAdditionalRequiredAssetMeterAttrs()
                                                                 throws MXException,
                                                                        java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • getAdditionalRequiredLocationMeterAttrs

        public java.util.Hashtable getAdditionalRequiredLocationMeterAttrs()
                                                                    throws MXException,
                                                                           java.rmi.RemoteException
        Throws:
        MXException
        java.rmi.RemoteException
      • canDelete

        public void canDelete()
                       throws MXException,
                              java.rmi.RemoteException
        A MeterGroup record can be deleted if it is not referenced by any of the following objects:

        • Asset
        • Item
        Overrides:
        canDelete in class Mbo
        Throws:
        MXApplicationException("meter", - "existsintable") is thrown when it is referenced by another object.
        MXException
        java.rmi.RemoteException
      • delete

        public void delete(long access)
                    throws MXException,
                           java.rmi.RemoteException
        when the MeterGroup is deleted, all related MeterInGroup records also need to be deleted.
        Specified by:
        delete in interface MboRemote
        Overrides:
        delete in class Mbo
        Parameters:
        access - 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)
      • duplicate

        public MboRemote duplicate()
                            throws MXException,
                                   java.rmi.RemoteException
        Duplicates this MeterGroup and its related objects.
        Specified by:
        duplicate in interface MboRemote
        Overrides:
        duplicate in class Mbo
        Returns:
        the newly duplicated MboRemote MeterGroup
        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 are MeterGroup fields that will be skipped without being copied to the newly duplicated MeterGroup
        • GROUPNAME
        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
        See Also:
        MeterGroup.loadSkipFieldCopyHashSet()