psdi.app.jobplan

Class JobPlanSpec

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


    public class JobPlanSpec
    extends SpecificationMbo
    implements JobPlanSpecRemote
    Mbo object to represent JobPlan Specification. See JobPlan Package description for details.

    This is a system level object.

    The key attributes in this object are as follows: JPNum, AssetAttrID, Section.

    The attributes in this object are as follows:

    Attribute NameDescription
    ALNValueAlphanumeric(text) value in entered units for the attribute specified. Editable only when the attribute is of ALN type. Defaults from ClassSpec.DefaultALNValue.
    AssetAttrIDAsset attribute identifier.
    ChangeDateName of the user who last modified this object. This attribute defaults to the current user unless another value is provided.
    ChangeDateThe date and time when this object was last modified. This attribute defaults to the MXServer date/time unless another value is provided.
    ClassSpecIDThe identifier of the classification specification from which the attributes are copied.
    ClassStructureIDIdentifier of the class structure associated with this item specification.Class structures are the hierarchies of classifications (for example, centrifugal or rotarty pumps) around which assets can be organized.
    DisplaySequenceA number to indicate this object's display sequence in the job plan's specification. Value is copied from corresponding class specification when the job plan specificition is created.
    JobPlanSpecIDSystem generated unique identification of this object.
    JPNumIdentifier for the Job Plan.
    LinkedToAttributeThe attribute to which this object is linked.
    LinkedToSectionThe section to which this object is linked.
    MandatoryIndicates whether value is needed.
    MeasureUnitIDUnit of Measure for the AlnValue or NumValue entered. Value is initially copied from ClassSpec but can be edited after the copy.
    NUMValueNumeric value in entered units for the attribute specified. Editable only when the attribute is of NUMERIC type.
    OrgIDIdentifier of the organization for this specification.
    RefObjectIDIdentifier of the Job Plan to which this JobPlanSpec is linked.
    RefObjectNameThe name or object (JobPlan) to which this JobPlanSpec is linked.
    SectionSection for a group of attributes.
    SiteIDIdentifier of the site for this specification.espectively
    • Constructor Detail

      • JobPlanSpec

        public JobPlanSpec(MboSet ms)
                    throws MXException,
                           java.rmi.RemoteException
        Construct the JOBPLANSPEC object
        Throws:
        MXException
        java.rmi.RemoteException
    • Method Detail

      • add

        public void add()
                 throws MXException,
                        java.rmi.RemoteException
        Set default values for a new JobPlanSpec object. The table below shows the default values for each of the attributes listed.
        Attribute NameAttribute Value
        changebyCurrent username
        changedateCurrent date
        classstructureidOwner classstructureid
        jpnumOwner job plan number
        orgidOwner organization identifier
        refobjectidOwner unique identifier
        refobjectnameOwner object name
        siteidOwner site identifier
        Specified by:
        add in interface MboRemote
        Overrides:
        add in class SpecificationMbo
        Throws:
        MXException
        java.rmi.RemoteException
      • 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 the JobPlanSpec fields will be skipped without being copied to the newly duplicated object:
        1. JPNUM
        2. REFOBJECTID CHANGEBY CHANGEDATE
        Overrides:
        skipCopyField in class Mbo
        Parameters:
        mvi - The MboValueInfo object of the MboValue that needs to be copied.
        Returns:
        true If the field does not need to be copied return true, in all other cases return false.
        Throws:
        java.rmi.RemoteException
        MXException
        See Also:
        psdi.app.jobplan.JobPlan#loadSkipFieldCopyHashSet
      • propagateKeyValue

        public void propagateKeyValue(java.lang.String keyName,
                                      java.lang.String keyValue)
                               throws MXException,
                                      java.rmi.RemoteException
        Description copied from class: Mbo
        Method for propagating key value. Provide an implementation of the method only when the parent's key values need to be propagate down to this MBO which is a child of a MBO set obtained through a relationship from the parent, and only when the key attribute of the parent are not one of the key attributes of the child MBO. When overwrite this method, please don't call super().
        Specified by:
        propagateKeyValue in interface MboRemote
        Overrides:
        propagateKeyValue in class Mbo
        Throws:
        MXException
        java.rmi.RemoteException