psdi.mbo

Class MboSetInfo

  • All Implemented Interfaces:
    java.io.Serializable


    public class MboSetInfo
    extends CachedObjectPointer
    implements java.io.Serializable
    This class represents information about a MAXIMO business object. A business object has name, implementation class name (a Java class with a fully qualified package name), a database table or view name on which it is based, whether it is inherited from another business object or not, the level at which it is used (site/organization/system/organizationWithSite), whether enabled for electronic auditing or not and any filters that are defined for electronic signature and electronic auditing.

    A business object aslo has relationships to other business objects. The relationships are used to construct appropriate business objects and to fetch appropriate data from database.

    This class provides various methods to retrieve business object information.

    See Also:
    Serialized Form
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static java.lang.String CACHE_NAME 
      static int COMPANYSET4
      Flag to indicate company set level business object
      static int INTNOLIMIT 
      static int INTNOTINITIALIZED 
      static int ITEMSET3
      Flag to indicate item set level business object
      static int ORGAPPFILTER7
      this type will be treated as Org level but can ask the Profile for a list of Sites in the context of an application so that the app can filter data
      static int ORGLEVEL2
      Flag to indicate organization level business object.
      static int ORGSITE10
      These applications will be treated like Org level applications but can ask the Profile for Sites
      static int RestrictionEvalByOrg 
      static int RestrictionEvalBySite 
      static int RestrictionEvalBySiteOrg 
      static int RestrictionEvalSystem 
      static int SITEAPPFILTER8
      this type will be treated as SITE level but can ask the Profile for a list of Sites in the context of an application so that the app can filter data
      static int SITELEVEL1
      Flag to indicate site level business object.
      protected java.lang.Object syncLock 
      static int SYSTEMAPPFILTER6
      this type will be treated like System level applications, but can ask the Profile for a list of sites and/or Orgs in the context of an application so that the app can filter the data.
      static int SYSTEMLEVEL0
      Flag to indicate system level business object.
      static int SYSTEMORG11
      These applications will be treated like System level applications but can ask the Profile for Orgs.
      static int SYSTEMORGSITE9
      These apps will be treated like System level applications, but can ask the Profile for a list of orgs or Sites
      static int SYSTEMSITE5
      Flag to indicate system with site level business object Here org and site can be optional
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void addAttribute(MboValueInfo attributeInfo)
      Adds attribute information to the cache that this object maintains for quick lookup.
      void clearAttributes()
      For use by MaximoDD cleanNonAutoViews.
      int evalForDataRestriction()
      This method what attribute value (if any) should be passed to Profile when determining whether a data restriction should be applied to a Mbo.
      java.util.HashSet getAllUniqueColumns()
      Returns a hashset of all unique column names.
      java.lang.String getAppValidateEventName() 
      EventTopic[] getAppValidateEventTopic()
      Get the event topic for the init of this kind of Mbo.
      MboValueInfo getAttribute(java.lang.String attributeName)
      Looks up the attrbute name in the cache to get the attribute information.
      int getAttributeCount()
      Returns the number of attributes that this business object has.
      java.util.Map getAttributeDetails()
      For use by MaximoDD cleanNonAutoViews.
      java.util.Iterator getAttributes()
      Returns an Iterator to iterate over all the attributes of this business object.
      MboSetInfo getBaseMboInfo()
      Returns reference to a base business object information, if this business object is inherited from another business object.
      java.lang.String getCacheName() 
      java.lang.String getClassName()
      Returns a Java class name with a fully qualified package name that provides implementation details of the business object.
      java.lang.String getContentAttrName()
      Returns unique Content Attribute Name associated with the given object, if any.
      java.lang.String getDescription()
      Returns description of what this business object is for.
      java.util.Iterator getEAuditAttributes()
      Returns an array of attributes that are enabled for electronic audit and for which the values need to be saved to the audit table.
      java.lang.String getEAuditFilter()
      Returns a filter (SQL where clause) to be applied to determine whether the business object data modifications need to be prompted for electronic signature.
      Entity getEntity()
      Returns an Entity object reference that can be used to find out persistance details of this object.
      java.lang.String getEntityName()
      Returns name of database table or view on which this business object is based.
      java.lang.String getESigFilter()
      Returns a filter (SQL where clause) to be applied to determine whether the business object data modifications need to be prompted for electronic signature or not.
      int getExtendedAttributeCount()
      Returns the number of extended attributes that this business object has.
      int getExtendedAttributeNumber() 
      java.util.Iterator getExtendedAttributes()
      Returns an Iterator to iterate over all the extended attributes of this business object.
      java.lang.String getExtendedViewName() 
      java.lang.String getExtendsObject()
      Returns base business object name from which this business object is inherited, if the business object is inherited from another one.
      int getFetchAttributeCount()
      Returns the number of fetch attributes that this business object has.
      int getFetchAttributeNumber() 
      java.util.Iterator getFetchAttributes()
      Returns an Iterator to iterate over all the fetch attributes of this business object.
      int getFetchStopLimit()
      Get the fetch stop limit.
      java.util.List getHierarchyList() 
      java.lang.String getInitEventName() 
      EventTopic[] getInitEventTopic()
      Get the event topic for the init of this kind of Mbo.
      java.util.Iterator getKeyAttributeIterator()
      Returns an Iterator to iterate over all the key attributes of this business object.
      java.lang.String[] getKeyAttributes()
      Returns an array of primary key attribute names in the primary key sequence sort order.
      java.lang.String getKeyRelationship()
      Returns a SQL where clause with the appropriate key attribute bindings.
      java.lang.String getKeyRelationshipWhere() 
      int getKeySize()
      Returns the number of attributes that form a key.
      java.util.HashMap getLangTableNames()
      Return the language table names of this object.
      java.lang.String getLatitude()
      Sets information where to get Latitude for this object.
      java.util.Iterator getLongDescriptionAttributes()
      Returns an Iterator to iterate over all the attributes of this business object that have long description.
      java.lang.String getLongtitude()
      Sets information where to get Longitude for this object.
      MXLogger getMboLogger()
      Returns a logger to log messages related to this business object.
      java.lang.Class getMboSetClass()
      Return the class of the MboSet to be used to instantiate the.
      int getMboValueCount()
      Returns the number of attributes associated with this business object.
      MboValueInfo getMboValueInfo(java.lang.String attributeName)
      Looks up the attrbute name in the cache to get the attribute information.
      java.util.Enumeration getMboValuesInfo()
      Return an Enumeration object to enumerate over all attributes of this business object.
      java.lang.String getName()
      Returns the name of the business object.
      java.lang.String getObjectName()
      Returns the name of this Business object.
      int getPersistentAttributeCount()
      Returns the number of persistent attributes that this business object has.
      java.util.Iterator getPersistentAttributes()
      Returns an Iterator to iterate over all the persistent attributes of this business object.
      int getPresistentAttributeNumber() 
      RelationInfo getRelationInfo(java.lang.String relationshipName)
      Returns relationship information for the given relationship name.
      RelationInfo getRelationshipToChild(java.lang.String child)
      Returns relationship information for the given business object name, if the given business object name is related to this one.
      java.util.Iterator getRelationsInfo()
      Returns an Iterator to iterate over all the relationships that this business object has with other business objects.
      java.lang.String getResourceType()
      Returns resource type.
      MXLogger getSecurityLogger()
      Returns a logger to log SQL messages related to this business object.
      ServiceInfo getServiceInfo()
      Return information about the service for this MboSet.
      java.lang.String getServiceName()
      Returns service name that represents the business object.
      int getSiteOrgType()
      Level at which the business object is used (site/organization/system/organizationWithSite).
      java.lang.String getSiteOrgTypeAsString()
      Returns the level at which the business object is used (site/organization/system/organizationWithSite).
      MXLogger getSqlLogger()
      Returns a logger to log SQL messages related to this business object.
      java.lang.String[] getTableAndColumn(java.lang.String attr)
      Return the Table and column name of the entity attribute.
      java.lang.String getTextdirection() 
      MXLogger getTransactionLogger()
      Get the transaction logger.
      MboSetInfoBase getTypedReference() 
      java.util.HashSet getUniqueEntityColumns() 
      java.lang.String getUniqueIDName()
      Returns unique ID Name associated with the given object, if any.
      boolean hasExtendedAttrs()
      Returns true if this is an original object and it has extended attributes.
      boolean hasNullableKeyAttr()
      Returns whether there is nullable key fields.
      boolean isAsUniqueId(java.lang.String attrName)
      Whether the passed in attribute corresponding to a unique id column of a table that this object is based on.
      boolean isAuditTable()
      Whether this is an audit table.
      boolean isBasedOn(java.lang.String name)
      Returns whether this business object is based on the given object name or not.
      boolean isEAuditEnabled()
      Returns whether this business object is enabled for electronic auditing or not.
      boolean isImported()
      Returns whether or not the business object is created based on a table that is imported into MAXIMO data dictionary tables.
      boolean isIncludedParentRelationship() 
      boolean isInternal()
      Returns whether this business object is and internal one.
      boolean isLanguageTable()
      Whether this is the language table.
      boolean isMainObject()
      Returns whether this object is Main object.
      boolean isMLInUse()
      Wether the multi-language support is turned on for this mbo set.
      boolean isNOSql()
      Returns indicator if resource type.SQL or NOSQL (not-only SQL)
      boolean isPersistent()
      Returns whether the business object is persistent or not (whether the data is stored/retrieved from the database or not).
      boolean isTenantOwned() 
      boolean isTextSearchEnabled() 
      boolean isUserdefined()
      Returns whether the business object is default MAXIMO provided or something that the customer has created.
      boolean isView()
      Returns whether the business object is based on a database view or not.
      void resolveReferences() 
      void setBaseMboInfo(MboSetInfo info)
      Sets reference to a base business object information, if this business object is inherited from another business object.
      void setEntity(Entity entity)
      Set the Entity object reference that can be used to find out persistance details of this object.
      void setExtendedAttributeNumber(int extendedAttributeNumber) 
      void setFetchAttributeNumber(int fetchAttributeNumber) 
      void setHasExtendedAttrs(boolean hasExtendedAttrs) 
      void setHierarchyList(java.util.List hierarchyList)
      Sets list of business object names in the hierarchy order from root to leaf node, used mainly to quickly figure out the inheritance hierarchy and to figure out whether the business object is inheriting from a given business object name.
      void setInternal(boolean flag)
      Sets whether this business object is internal one.
      void setLatitude(java.lang.String refy)
      Sets information where to get Latitude for this object.
      void setLongtitude(java.lang.String refx)
      Sets information where to get Longitude for this object.
      void setPresistentAttributeNumber(int persistentAttributeNumber) 
      void setRelationships(java.util.HashMap relationships)
      Sets the collection of relationships to be used by this business object.
      void setServiceInfo(ServiceInfo si)
      Set the information about the service for this MboSet.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • syncLock

        protected transient volatile java.lang.Object syncLock
      • SYSTEMLEVEL0

        public static final int SYSTEMLEVEL0
        Flag to indicate system level business object.
        See Also:
        Constant Field Values
      • SITELEVEL1

        public static final int SITELEVEL1
        Flag to indicate site level business object.
        See Also:
        Constant Field Values
      • ORGLEVEL2

        public static final int ORGLEVEL2
        Flag to indicate organization level business object.
        See Also:
        Constant Field Values
      • ITEMSET3

        public static final int ITEMSET3
        Flag to indicate item set level business object
        See Also:
        Constant Field Values
      • COMPANYSET4

        public static final int COMPANYSET4
        Flag to indicate company set level business object
        See Also:
        Constant Field Values
      • SYSTEMSITE5

        public static final int SYSTEMSITE5
        Flag to indicate system with site level business object Here org and site can be optional
        See Also:
        Constant Field Values
      • SYSTEMAPPFILTER6

        public static final int SYSTEMAPPFILTER6
        this type will be treated like System level applications, but can ask the Profile for a list of sites and/or Orgs in the context of an application so that the app can filter the data.
        See Also:
        Constant Field Values
      • ORGAPPFILTER7

        public static final int ORGAPPFILTER7
        this type will be treated as Org level but can ask the Profile for a list of Sites in the context of an application so that the app can filter data
        See Also:
        Constant Field Values
      • SITEAPPFILTER8

        public static final int SITEAPPFILTER8
        this type will be treated as SITE level but can ask the Profile for a list of Sites in the context of an application so that the app can filter data
        See Also:
        Constant Field Values
      • SYSTEMORGSITE9

        public static final int SYSTEMORGSITE9
        These apps will be treated like System level applications, but can ask the Profile for a list of orgs or Sites
        See Also:
        Constant Field Values
      • ORGSITE10

        public static final int ORGSITE10
        These applications will be treated like Org level applications but can ask the Profile for Sites
        See Also:
        Constant Field Values
      • SYSTEMORG11

        public static final int SYSTEMORG11
        These applications will be treated like System level applications but can ask the Profile for Orgs.
        See Also:
        Constant Field Values
      • RestrictionEvalBySiteOrg

        public static final int RestrictionEvalBySiteOrg
        See Also:
        Constant Field Values
    • Method Detail

      • isTenantOwned

        public boolean isTenantOwned()
      • getKeyRelationshipWhere

        public java.lang.String getKeyRelationshipWhere()
      • getUniqueEntityColumns

        public java.util.HashSet getUniqueEntityColumns()
      • isIncludedParentRelationship

        public boolean isIncludedParentRelationship()
      • getUniqueIDName

        public java.lang.String getUniqueIDName()
        Returns unique ID Name associated with the given object, if any.
        Returns:
        unique ID Name associated with the given object, if any, otherwise returns null.
      • getContentAttrName

        public java.lang.String getContentAttrName()
        Returns unique Content Attribute Name associated with the given object, if any.
        Returns:
        Content Attribute Name associated with the given object, if any, otherwise returns null.
      • getClassName

        public java.lang.String getClassName()
        Returns a Java class name with a fully qualified package name that provides implementation details of the business object.
        Returns:
        A Java class name with a fully qualified package name
      • getDescription

        public java.lang.String getDescription()
        Returns description of what this business object is for.
        Returns:
        description of what this business object is for
      • isMainObject

        public boolean isMainObject()
        Returns whether this object is Main object.
        Returns:
        name of this main object.
      • isEAuditEnabled

        public boolean isEAuditEnabled()
        Returns whether this business object is enabled for electronic auditing or not.
        Returns:
        true, if this business object is enabled for electronic auditing, otherwise returns false.
      • getEAuditFilter

        public java.lang.String getEAuditFilter()
        Returns a filter (SQL where clause) to be applied to determine whether the business object data modifications need to be prompted for electronic signature.
        Returns:
        a filter (SQL where clause) to be applied to determine whether the business object data modifications need to be prompted for electronic signature. Returns null, if there is no filter defined.
      • getESigFilter

        public java.lang.String getESigFilter()
        Returns a filter (SQL where clause) to be applied to determine whether the business object data modifications need to be prompted for electronic signature or not.
        Returns:
        a filter (SQL where clause) to be applied to determine whether the business object data modifications need to be prompted for electronic signature or not. Returns null, if there is no filter defined.
      • getEntityName

        public java.lang.String getEntityName()
        Returns name of database table or view on which this business object is based. The data is fetched from the database using this name in the SQL query.
        Returns:
        name of table or view on which this business object is based. Returns null, if the business object is non-persistent and is not based on any table or view.
      • getExtendsObject

        public java.lang.String getExtendsObject()
        Returns base business object name from which this business object is inherited, if the business object is inherited from another one.
        Returns:
        base business object name from which this business object is extended. Returns null, if the business object is not an extended business object.
      • getResourceType

        public java.lang.String getResourceType()
        Returns resource type. Can be SQL or NOSQL (not-only SQL)
        Returns:
        resource type.
      • isNOSql

        public boolean isNOSql()
        Returns indicator if resource type.SQL or NOSQL (not-only SQL)
        Returns:
        is resource type NOSQL.
      • isView

        public boolean isView()
        Returns whether the business object is based on a database view or not. All inherited business objects are based on a database view.
        Returns:
        true, if the business object is based on a database view, otherwise false.
      • getObjectName

        public java.lang.String getObjectName()
        Returns the name of this Business object.
        Returns:
        name of this Business object.
      • isPersistent

        public boolean isPersistent()
        Returns whether the business object is persistent or not (whether the data is stored/retrieved from the database or not).
        Returns:
        true, if the business object is persistent, otherwise false.
      • getServiceName

        public java.lang.String getServiceName()
        Returns service name that represents the business object.
        Returns:
        service name that represents the business object.
      • getSiteOrgType

        public int getSiteOrgType()
        Level at which the business object is used (site/organization/system/organizationWithSite). An integer value used to represent level.
        Returns:
        an integer value (either SYSTEMLEVEL0, SITELEVEL1, ORGLEVEL2, ORGWITHSITE3) that represents level of usage of this business object.
      • getSiteOrgTypeAsString

        public java.lang.String getSiteOrgTypeAsString()
        Returns the level at which the business object is used (site/organization/system/organizationWithSite).
        Returns:
        a String value (either SYSTEM, SITE, ORG, ORGSITE) that represents level of usage of this business object.
      • isUserdefined

        public boolean isUserdefined()
        Returns whether the business object is default MAXIMO provided or something that the customer has created.
        Returns:
        true if this business object is user defined, otherwise false.
      • isImported

        public boolean isImported()
        Returns whether or not the business object is created based on a table that is imported into MAXIMO data dictionary tables.
        Returns:
        true if this business object is created based on a table that is imported into MAXIMO data dictionary tables.
      • isInternal

        public boolean isInternal()
        Returns whether this business object is and internal one.
        Returns:
        true, if this business object is internal, otherwise returns false.
      • setInternal

        public void setInternal(boolean flag)
        Sets whether this business object is internal one.
        Parameters:
        flag - pass true value to indicate that the business object is internal, otherwise pass false.
      • getName

        public java.lang.String getName()
        Returns the name of the business object.
        Returns:
        name of the business object.
      • getInitEventName

        public java.lang.String getInitEventName()
      • getAppValidateEventName

        public java.lang.String getAppValidateEventName()
      • getFetchStopLimit

        public int getFetchStopLimit()
        Get the fetch stop limit.
      • getTextdirection

        public java.lang.String getTextdirection()
      • setHierarchyList

        public void setHierarchyList(java.util.List hierarchyList)
        Sets list of business object names in the hierarchy order from root to leaf node, used mainly to quickly figure out the inheritance hierarchy and to figure out whether the business object is inheriting from a given business object name.
        Parameters:
        hierarchyList - a list of business object names in the hierarchy order from root to leaf node.
      • getHierarchyList

        public java.util.List getHierarchyList()
      • evalForDataRestriction

        public int evalForDataRestriction()
        This method what attribute value (if any) should be passed to Profile when determining whether a data restriction should be applied to a Mbo.
        Returns:
        0 to 3.
        • If 0, then pass null to Profile method useDataRestriction.
        • If 1, then pass the Mbo string value of siteid.
        • If 2, then pass the Mbo string value of orgid
        • If 3, then if siteid is not null, pass siteid; otherwise pass orgid.
        See Also:
        Profile.useDataRestriction(java.lang.String, java.lang.String, java.lang.String)
      • getAttributeDetails

        public java.util.Map getAttributeDetails()
        For use by MaximoDD cleanNonAutoViews.
      • clearAttributes

        public void clearAttributes()
        For use by MaximoDD cleanNonAutoViews.
      • addAttribute

        public void addAttribute(MboValueInfo attributeInfo)
        Adds attribute information to the cache that this object maintains for quick lookup.
        Parameters:
        attributeInfo - attribute information to be added.
      • getAttribute

        public MboValueInfo getAttribute(java.lang.String attributeName)
        Looks up the attrbute name in the cache to get the attribute information. Returns the attribute information in MboValueInfo object, if the attribute name is present in the cache, otherwise returns null.
        Parameters:
        attributeName - name of the attribute for which the attribute information is needed.
        Returns:
        attribute information in MboValueInfo object, if the attribute name is present in the cache, otherwise returns null.
      • getEntity

        public Entity getEntity()
        Returns an Entity object reference that can be used to find out persistance details of this object.
        Returns:
        an Entity object reference that can be used to find out persistance details of this object, only if this object data is represented in database, otherwise returns null.
      • setEntity

        public void setEntity(Entity entity)
        Set the Entity object reference that can be used to find out persistance details of this object.
        Parameters:
        entity - an Entity object reference that can be used to find out persistance details of this object.
      • getAttributeCount

        public int getAttributeCount()
        Returns the number of attributes that this business object has. The returned count includes the sum of persistent and non-persistent attributes.
        Returns:
        the number of attributes that this business object has.
      • getPersistentAttributeCount

        public int getPersistentAttributeCount()
        Returns the number of persistent attributes that this business object has. The extended attributes that are hosted on separate extension table are not include in this list.
        Returns:
        the number of persistent attributes that this business object has.
      • getExtendedAttributeCount

        public int getExtendedAttributeCount()
        Returns the number of extended attributes that this business object has.
        Returns:
        the number of extended attributes that this business object has.
      • getFetchAttributeCount

        public int getFetchAttributeCount()
        Returns the number of fetch attributes that this business object has.
        Returns:
        the number of fetch attributes that this business object has.
      • getAttributes

        public java.util.Iterator getAttributes()
        Returns an Iterator to iterate over all the attributes of this business object. The attributes are always returned in the sorted order of the attribute number. The iterator objects are of type MboValueInfo.
        Returns:
        an Iterator to iterate over all the attributes of this business object.
      • getPersistentAttributes

        public java.util.Iterator getPersistentAttributes()
        Returns an Iterator to iterate over all the persistent attributes of this business object. The extended attributes that are hosted on separate extension table are not include in this list. The attributes are always returned in the sorted order of the persistent attribute number. The iterator objects are of type MboValueInfo.
        Returns:
        an Iterator to iterate over all the persistent attributes of this business object.
      • getExtendedAttributes

        public java.util.Iterator getExtendedAttributes()
        Returns an Iterator to iterate over all the extended attributes of this business object. The attributes are always returned in the sorted order of the extended attribute number. The iterator objects are of type MboValueInfo.
        Returns:
        an Iterator to iterate over all the extended attributes of this business object.
      • getFetchAttributes

        public java.util.Iterator getFetchAttributes()
        Returns an Iterator to iterate over all the fetch attributes of this business object. The attributes are always returned in the sorted order of the fetch attribute number. The iterator objects are of type MboValueInfo.
        Returns:
        an Iterator to iterate over all the fetch attributes of this business object.
      • getKeyAttributeIterator

        public java.util.Iterator getKeyAttributeIterator()
        Returns an Iterator to iterate over all the key attributes of this business object. The attributes are always returned in the sorted order of the primary key sequence number. The iterator objects are of type MboValueInfo.
        Returns:
        an Iterator to iterate over all the key attributes of this business object.
      • getLongDescriptionAttributes

        public java.util.Iterator getLongDescriptionAttributes()
        Returns an Iterator to iterate over all the attributes of this business object that have long description. The attributes are returned in unspecified order. The iterator objects are of type MboValueInfo.
        Returns:
        an Iterator to iterate over all the attributes of this business object that have long description.
      • getKeySize

        public int getKeySize()
        Returns the number of attributes that form a key.
        Returns:
        the number of attributes that form a key.
      • getBaseMboInfo

        public MboSetInfo getBaseMboInfo()
        Returns reference to a base business object information, if this business object is inherited from another business object.
        Returns:
        reference to a base business object information, if this business object is inherited from another business object, otherwise null.
      • setBaseMboInfo

        public void setBaseMboInfo(MboSetInfo info)
        Sets reference to a base business object information, if this business object is inherited from another business object.
        Parameters:
        info - a base business object information.
      • isBasedOn

        public boolean isBasedOn(java.lang.String name)
        Returns whether this business object is based on the given object name or not.
        Parameters:
        name - a business object name to be verified to see whether it is based on this business object.
        Returns:
        true, if this business object is based on the given object name, otherwise false.
      • setPresistentAttributeNumber

        public void setPresistentAttributeNumber(int persistentAttributeNumber)
      • setExtendedAttributeNumber

        public void setExtendedAttributeNumber(int extendedAttributeNumber)
      • setFetchAttributeNumber

        public void setFetchAttributeNumber(int fetchAttributeNumber)
      • getPresistentAttributeNumber

        public int getPresistentAttributeNumber()
      • getExtendedAttributeNumber

        public int getExtendedAttributeNumber()
      • getFetchAttributeNumber

        public int getFetchAttributeNumber()
      • getMboLogger

        public MXLogger getMboLogger()
        Returns a logger to log messages related to this business object.
        Returns:
        MXLogger a logger to log messages related to this business object.
      • getSecurityLogger

        public MXLogger getSecurityLogger()
        Returns a logger to log SQL messages related to this business object.
        Returns:
        MXLogger a logger to log SQL messages related to this business object.
      • getSqlLogger

        public MXLogger getSqlLogger()
        Returns a logger to log SQL messages related to this business object.
        Returns:
        MXLogger a logger to log SQL messages related to this business object.
      • getServiceInfo

        public ServiceInfo getServiceInfo()
        Return information about the service for this MboSet.
        Returns:
        information about the service for this MboSet in a ServiceInfo object.
      • setServiceInfo

        public void setServiceInfo(ServiceInfo si)
        Set the information about the service for this MboSet.
        Parameters:
        si - service information reference.
      • getMboSetClass

        public java.lang.Class getMboSetClass()
                                       throws java.lang.ClassNotFoundException
        Return the class of the MboSet to be used to instantiate the. business object.
        Returns:
        the class object that is used to instantiate the business object.
        Throws:
        java.lang.ClassNotFoundException - if fails to load the class.
      • getMboValueCount

        public int getMboValueCount()
        Returns the number of attributes associated with this business object.
        Returns:
        the number of attributes associated with this business object.
      • getKeyAttributes

        public java.lang.String[] getKeyAttributes()
        Returns an array of primary key attribute names in the primary key sequence sort order.
        Returns:
        an array of primary key attribute names in the primary key sequence sort order. If the business object does not have any primary keys, returns the array with size 0.
      • getKeyRelationship

        public java.lang.String getKeyRelationship()
        Returns a SQL where clause with the appropriate key attribute bindings.
        Returns:
        a SQL where clause with the appropriate key attribute bindings.
      • getMboValueInfo

        public MboValueInfo getMboValueInfo(java.lang.String attributeName)
        Looks up the attrbute name in the cache to get the attribute information. Returns the attribute information in MboValueInfo object, if the attribute name is present in the cache, otherwise returns null.
        Parameters:
        attributeName - name of the attribute for which the attribute information is needed.
        Returns:
        attribute information in MboValueInfo object, if the attribute name is present in the cache, otherwise returns null.
      • getMboValuesInfo

        public java.util.Enumeration getMboValuesInfo()
        Return an Enumeration object to enumerate over all attributes of this business object. All the objects returned by the enumerator are of type MboValueInfo.
        Returns:
        an Enumeration object to enumerate over all attributes of this business object.
      • setRelationships

        public void setRelationships(java.util.HashMap relationships)
        Sets the collection of relationships to be used by this business object. The relationships collection must be a map with key as the relationship name and the value as RelationInfo object.
        Parameters:
        relationships - collection of relationships to be used by this business object.
      • getRelationInfo

        public RelationInfo getRelationInfo(java.lang.String relationshipName)
        Returns relationship information for the given relationship name. If a relationship exists with the given name for this business object, returns the corresponding RelationInfo object, otherwise checks to see whether a relationship name exists on a parent business object (for inherited business object) and returns the corresponding RelationInfo object available at the parent level. If none are matched, then returns null.
        Parameters:
        relationshipName - name of the relationship for which additional information is needed.
        Returns:
        relationship information for the given relationship name if there exists a relationship with the name, otherwise retuns null. Also checks to see whether the relationship name exists with the parent business object (for inherited business objects) and returns relationship information if exists, otherwise returns null.
      • getRelationshipToChild

        public RelationInfo getRelationshipToChild(java.lang.String child)
        Returns relationship information for the given business object name, if the given business object name is related to this one. If there is more than one relationship defined to the specified child, the first one is retunred.
        Parameters:
        child - name of the child for which relationship information is needed.
        Returns:
        relationship information for the given child name if there exists a relationship, otherwise retuns null.
      • getRelationsInfo

        public java.util.Iterator getRelationsInfo()
        Returns an Iterator to iterate over all the relationships that this business object has with other business objects. The iterator objects are of type RelationInfo.
        Returns:
        an Iterator to iterate over all the relationships that this business object has with other business objects.
      • getEAuditAttributes

        public java.util.Iterator getEAuditAttributes()
        Returns an array of attributes that are enabled for electronic audit and for which the values need to be saved to the audit table. The returned array would always include the key attributes.
        Returns:
        an array of attributes that are enabled for electronic audit and for which the values need to be saved to the audit table.
      • getLangTableNames

        public java.util.HashMap getLangTableNames()
                                            throws java.rmi.RemoteException
        Return the language table names of this object. It is hashmap with key as the tablename and value is the language table name.
        Returns:
        Throws:
        java.rmi.RemoteException
      • getTableAndColumn

        public java.lang.String[] getTableAndColumn(java.lang.String attr)
        Return the Table and column name of the entity attribute.
        Parameters:
        attr -
        Returns:
        String[0] is table name. String[1] is columnname.
      • isMLInUse

        public boolean isMLInUse()
                          throws java.rmi.RemoteException
        Wether the multi-language support is turned on for this mbo set. If it is a view, it will return true if any table the view is based on is ML in use. It doesn't check MLSUPPORT maxvar. in use.
        Parameters:
        tableName -
        Returns:
        Throws:
        java.rmi.RemoteException
      • isAuditTable

        public boolean isAuditTable()
        Whether this is an audit table.
      • isLanguageTable

        public boolean isLanguageTable()
        Whether this is the language table.
        Returns:
      • isTextSearchEnabled

        public boolean isTextSearchEnabled()
      • getInitEventTopic

        public EventTopic[] getInitEventTopic()
                                       throws MXException
        Get the event topic for the init of this kind of Mbo.
        Returns:
        Throws:
        MXException
      • getAppValidateEventTopic

        public EventTopic[] getAppValidateEventTopic()
                                              throws MXException
        Get the event topic for the init of this kind of Mbo.
        Returns:
        Throws:
        MXException
      • getAllUniqueColumns

        public java.util.HashSet getAllUniqueColumns()
        Returns a hashset of all unique column names. It contains the entity column names corresponding to the unique columns of all the tables that this object is based on.
        Returns:
      • isAsUniqueId

        public boolean isAsUniqueId(java.lang.String attrName)
        Whether the passed in attribute corresponding to a unique id column of a table that this object is based on.
      • getTransactionLogger

        public MXLogger getTransactionLogger()
        Get the transaction logger. The transaction logger is maximo.txn.servicename.objectname.
        Returns:
      • hasNullableKeyAttr

        public boolean hasNullableKeyAttr()
        Returns whether there is nullable key fields.
        Returns:
      • resolveReferences

        public void resolveReferences()
      • hasExtendedAttrs

        public boolean hasExtendedAttrs()
        Returns true if this is an original object and it has extended attributes.
      • setHasExtendedAttrs

        public void setHasExtendedAttrs(boolean hasExtendedAttrs)
      • getLatitude

        public java.lang.String getLatitude()
        Sets information where to get Latitude for this object.
        Parameters:
        ref - latitude location
      • getLongtitude

        public java.lang.String getLongtitude()
        Sets information where to get Longitude for this object.
        Parameters:
        ref - Longitude location
      • setLatitude

        public void setLatitude(java.lang.String refy)
        Sets information where to get Latitude for this object.
        Parameters:
        ref - latitude location
      • setLongtitude

        public void setLongtitude(java.lang.String refx)
        Sets information where to get Longitude for this object.
        Parameters:
        ref - Longitude location
      • getExtendedViewName

        public java.lang.String getExtendedViewName()