psdi.iface.app.intobject

Class MaxIntObject

  • java.lang.Object
  • All Implemented Interfaces:
    java.rmi.Remote, MaxIntObjectRemote, MboConstants, MboRemote, MaxRemoteProxy


    public class MaxIntObject
    extends Mbo
    implements MaxIntObjectRemote
    MBO to represent MaxIntObject. See the Object Structure package description for details.

    The key attributes for this object is INTOBJECTNAME.

    The attributes in this object are as follows:

    Attribute NameDescription
    ALIASCONFLICTRead only Flag identifying if the Alias Validation process identified duplicate field names in some of the MOS' MBO components
    ChangeBy, ChangeDate The name of the person who last modified the form and the date on which the form was last modified.
    CONFIGURABLERead-only flag identifying if the Object structure can be modified. By default any User Defined MOS will have this flag ENABLED; for non-user defined MOS, the Configurable flag could be ENABLED or DISABLED depending on MOS design constraints.
    DEFCLASSProperty that references a processing class that specifies rules applicable to the process of filtering non-relevant MBO content from the MOS structure.
    DESCRIPTIONDescription of Object Structure
    DESCRIPTION_LONGDESCRIPTION Long description
    FLATSUPPORTEDFlag identifying if the MOS structure supports Flat Files and Interface Tables processing. By default new MOS structures will have this flag DISABLED. For MOS elements with this flag enabled, the save validation process should check for duplicate field names in any of its MBO components.
    HASLD has lond description
    INTOBJECTNAME Object Structure name
    LANGCODElanguage code
    MAXINTOBJECTIDUnique Identifier for the MaxIntobject record.
    PROCCLASS Property that references a processing class that specifies rules applicable to the process of creating the MBO elements that constitute the MOS the MBOs that constitute the MOS
    QUERYONLYFlag identifying if the MOS structure can be used to create/update Maximo MBOs, by default any User Defined MOS will have this flag DISABLED. When this flag is DISABLED, the functionality provided by the MOS will be equivalent to a NOTIFY or QUERY operation. When this flag is ENABLED, the functionality provide by the MOS will be equivalent to either a QUERY or RESPONSE operations.
    SELFREFERENCINGEditable flag identifying if the MAIN MBO in the Object Structure the Object Structure includes a RELATIONSHIP with itself.
    USERDEFINEDrepresents that this object structure is a user defined OS.
    USEWITH represents applications that will make use of the MOS.
    USEWITHDESCRIPTION description of the application name.
    XMLDATANon persistant field to show the sample object structure service xml.

    • Constructor Detail

      • MaxIntObject

        public MaxIntObject(MboSet ms)
                     throws java.rmi.RemoteException
        Construct the MaxIntObject object
        Parameters:
        ms - MboSet
        Throws:
        java.rmi.RemoteException
    • Method Detail

      • createXML

        public void createXML()
                       throws MXException,
                              java.rmi.RemoteException
        Create Object Structure Service xml for given action/operation
        Specified by:
        createXML in interface MaxIntObjectRemote
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
      • generateSchema

        public void generateSchema()
                            throws MXException,
                                   java.rmi.RemoteException
        Create Object Structure Service schema. A valid host name and port should be set for "mxe.int.webappurl" property in "Proerty Maintenance" application before generating schema.
        Specified by:
        generateSchema in interface MaxIntObjectRemote
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
      • init

        public void init()
                  throws MXException
        Initialize Object Structure Mbo.
        Overrides:
        init in class Mbo
        Throws:
        MXException - throws MXException
      • handleAliasNP

        public void handleAliasNP()
                           throws MXException,
                                  java.rmi.RemoteException
        Creates MaxintObjAlias records. This method gets called from the Add/Modify action menu.
        Specified by:
        handleAliasNP in interface MaxIntObjectRemote
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
      • appValidate

        public void appValidate()
                         throws MXException,
                                java.rmi.RemoteException
        validates the AliasConflict flag
        Overrides:
        appValidate in class Mbo
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
      • save

        public void save()
                  throws MXException,
                         java.rmi.RemoteException
        Save time validation for ObjectStucture application
        Overrides:
        save in class Mbo
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
      • deleteApplicationEntries

        public void deleteApplicationEntries()
                                      throws MXException,
                                             java.rmi.RemoteException
        Identifies whether the Object Structure contains any source MBO record(MaxIntObjDetail).
        Throws:
        MXException - throws MXApplicationException if there is no SourceMBO record for that object structure.
        java.rmi.RemoteException - throws RemoteException
      • generateApplicationEntries

        public void generateApplicationEntries(boolean fromSave)
                                        throws MXException,
                                               java.rmi.RemoteException
        Identifies whether the Object Structure contains any source MBO record(MaxIntObjDetail).
        Throws:
        MXException - throws MXApplicationException if there is no SourceMBO record for that object structure.
        java.rmi.RemoteException - throws RemoteException
      • addServiceOptions

        public void addServiceOptions(MboSetRemote sigOptionSet)
                               throws MXException,
                                      java.rmi.RemoteException
        Return list of relationship name from the maxrelationship table.
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
      • add

        public void add()
                 throws MXException,
                        java.rmi.RemoteException
        Default value for some of the fields of the new Object Struture. The table below shows the default values for each of the attributes listed.
        userdefinedtrue
        changebyCurrent username
        changedateCurrent date
        configurabletrue
        aliasconflictfalse
        queryonlyfalse
        flatsupportedfalse
        Specified by:
        add in interface MboRemote
        Overrides:
        add in class Mbo
        Throws:
        MXException
        java.rmi.RemoteException
      • modify

        public void modify()
                    throws MXException,
                           java.rmi.RemoteException
        This is called whenever a change is made to the attributes of MaxIntObject. When any field related to MaxIntObject is changed, changedate and changeby is updated.
        Overrides:
        modify in class Mbo
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
      • delete

        public void delete(long accessModifier)
                    throws MXException,
                           java.rmi.RemoteException
        delete object structure record
        Specified by:
        delete in interface MboRemote
        Overrides:
        delete in class Mbo
        Parameters:
        accessModifier - Access Modifier
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
        See Also:
        Mbo.delete(long)
      • canDelete

        public void canDelete()
                       throws MXException,
                              java.rmi.RemoteException
        checks whether the object structure record can be deleted
        Overrides:
        canDelete in class Mbo
        Throws:
        MXException - throws MXApplicationException if the object structure was referenced in MAXIFACEIN, MAXIFACEOUT and MAXIFACEINVOKE tables/MBOs
        java.rmi.RemoteException - throws RemoteException
      • duplicate

        public MboRemote duplicate()
                            throws MXException,
                                   java.rmi.RemoteException
        Duplicates MaxIntObject record and its related MBOs. The related mbos includes MaxIntObjDetail,MaxIntobjCols,MaxIntobjAlias
        Specified by:
        duplicate in interface MboRemote
        Overrides:
        duplicate in class Mbo
        Returns:
        MboRemote The newly created Structure.
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
      • skipCopyField

        protected boolean skipCopyField(MboValueInfo mvi)
                                 throws MXException,
                                        java.rmi.RemoteException
        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 maxintobject fields will be skipped without being copied to the newly duplicated IntObject:
        1. intobjectname
        2. changeby
        3. 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:
        MXException
        java.rmi.RemoteException
        See Also:
        MaxIntObject.loadSkipFieldCopyHashSet()
      • handleIncludeExcludeNP

        public void handleIncludeExcludeNP()
                                    throws MXException,
                                           java.rmi.RemoteException
        Creates MaxintObjCols records. This method gets called from the Include/Exclude action menu.
        Specified by:
        handleIncludeExcludeNP in interface MaxIntObjectRemote
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
      • handleAdvanceCfg

        public void handleAdvanceCfg()
                              throws MXException,
                                     java.rmi.RemoteException
        Creates MaxintObjCols records. This method gets called from the Include/Exclude action menu.
        Specified by:
        handleAdvanceCfg in interface MaxIntObjectRemote
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
      • copySigOption

        public void copySigOption(java.util.Vector selected)
                           throws MXException,
                                  java.rmi.RemoteException
        Creates MaxintObjCols records. This method gets called from the Include/Exclude action menu.
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
      • createNewOption

        public void createNewOption(MboRemote sourceMbo,
                                    MboSetRemote sigOptionSet,
                                    boolean copyAuth)
                             throws MXException,
                                    java.rmi.RemoteException
        Creates MaxintObjCols records. This method gets called from the Include/Exclude action menu.
        Throws:
        MXException - throws MXException
        java.rmi.RemoteException - throws RemoteException
      • validateDescription

        public void validateDescription()
                                 throws MXException,
                                        java.rmi.RemoteException
        Checks that the description provided for the current object structure is unique within each language among the Reporting Object Structures (where usewith = REPORTING). Null descriptions are permitted.
        Specified by:
        validateDescription in interface MaxIntObjectRemote
        Throws:
        MXApplicationException - Thrown if a duplicate exists.
        MXException
        java.rmi.RemoteException