KPI (Maximo API)

java.lang.Object
- psdi.mbo.Mbo
- - psdi.app.kpi.KPI

All Implemented Interfaces:

java.rmi.Remote, KPIRemote, MboConstants, MboRemote, MaxRemoteProxy
```
public class KPI
extends Mbo
implements KPIRemote
```
Created on 1/12/04

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

KPI(MboSet ms)
Construct the KPI object

Constructors
Constructor and Description
`KPI(MboSet ms)` Construct the KPI object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add()` Add a mbo, defaulting the attributes shown below.
`void`	`canDelete()` Checks if this KPI is refrenced anywhere. Checks are made on KPIGraph portlet and KPi List portlet remotes, if a reference is not found then the KPI is deleted.
`void`	`delete(long accessModifier)` Mark the object to be deleted depending on the access modifier.
`MboRemote`	`duplicate()` Creates a duplicate KPI
`java.util.ArrayList`	`getComparisionKPIs()` Returns collection of KPI remotes that have to be compared with this KPI. KPITRENDCFG.COMPAREWITH is queried for this KPI
`java.util.Date`	`getCustomDates(boolean from)` This method returns the custom trend dates related to this KPI from KPIGTRENDCFG, its configuration table
`java.lang.String`	`getTrendRange()` Returns trend range based on what was selected by the user The values could be
`boolean`	`isClearRelatedKPI()`
`java.util.Vector`	`kpiInfo()` Returns all details about the current KPI as a Vector This method is called by UI layer basically for display
`void`	`run()` Runs the current KPI.
`protected void`	`save()` If the KPi hasn't been run , and it has been newly formed, then it is run.
`void`	`setClearRelatedKPI(boolean clearRelatedKPI)`
`protected boolean`	`skipCopyField(MboValueInfo mvi)` Overrides the skipCopyField() in the Mbo.
`void`	`updateTrend()`
`void`	`validateSQL()` Validates the current current KPI Checks if query is other than Select
`void`	`validateTrendInfo()` Validate whether trend information is correct for drawing chart and saving KPI. Range of start and end dates are validated for time range logic

Methods inherited from class psdi.mbo.Mbo
addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, deleteDoclinks, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, fireEvent, generateAutoKey, 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, init, 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, 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
addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, generateAutoKey, 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
  - KPI
```
public KPI(MboSet ms)
    throws MXException,
           java.rmi.RemoteException
```
    Construct the KPI object
    
    Parameters:
    
    ms - Mbo set
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
- Method Detail
  - add
```
public void add()
         throws MXException,
                java.rmi.RemoteException
```
    Add a mbo, defaulting the attributes shown below. Default values are :
    
    Attribute Name Attribute Value
    IsPublic True
    KPIDate Server Date
    Format DECIMAL
    Real Time Null
    Last KPI Value Null
    Owner Current user
    
    Specified by:
    
    add in interface MboRemote
    
    Overrides:
    
    add in class Mbo
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - run
```
public void run()
         throws MXException,
                java.rmi.RemoteException
```
    Runs the current KPI. Makes a complete SQL from Select and Clause and runs it as a direct query. Direct JDBC call is made using DBManager
    
    Specified by:
    
    run in interface KPIRemote
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - validateSQL
```
public void validateSQL()
                 throws MXException,
                        java.rmi.RemoteException
```
    Validates the current current KPI
    Checks if query is other than Select
    
    Specified by:
    
    validateSQL in interface KPIRemote
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - save
```
protected void save()
             throws MXException,
                    java.rmi.RemoteException
```
    If the KPi hasn't been run , and it has been newly formed, then it is run.
    
    Overrides:
    
    save in class Mbo
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
    
    See Also:
    
    Mbo.save()
  - duplicate
```
public MboRemote duplicate()
                    throws MXException,
                           java.rmi.RemoteException
```
    Creates a duplicate KPI
    
    Specified by:
    
    duplicate in interface MboRemote
    
    Overrides:
    
    duplicate in class Mbo
    
    Returns:
    
    the newly duplicated MboRemote KPI
    
    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 KPI fields that will be skipped without being copied to the newly duplicated KPI
    1. KPINAME
    Overrides:
    
    skipCopyField in class Mbo
    
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - canDelete
```
public void canDelete()
               throws MXException,
                      java.rmi.RemoteException
```
    Checks if this KPI is refrenced anywhere.
    Checks are made on KPIGraph portlet and KPi List portlet remotes, if a reference is not found then the KPI is deleted.
    
    Overrides:
    
    canDelete in class Mbo
    
    Throws:
    
    MXApplicationException("kpi", - "DeleteKPIL") is thrown when it is referenced by a KPILCONFIG object.
    
    MXApplicationException("kpi", - "DeleteKPIG") is thrown when it is referenced by a KPIGCONFIG object.
    
    MXException
    
    java.rmi.RemoteException
  - kpiInfo
```
public java.util.Vector kpiInfo()
                         throws MXException,
                                java.rmi.RemoteException
```
    Returns all details about the current KPI as a Vector This method is called by UI layer basically for display
    
    Specified by:
    
    kpiInfo in interface KPIRemote
    
    Returns:
    
    Vector containing all information about this KPI
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - getComparisionKPIs
```
public java.util.ArrayList getComparisionKPIs()
                                       throws MXException,
                                              java.rmi.RemoteException
```
    Returns collection of KPI remotes that have to be compared with this KPI.
    KPITRENDCFG.COMPAREWITH is queried for this KPI
    
    Specified by:
    
    getComparisionKPIs in interface KPIRemote
    
    Returns:
    
    ArrayList of all kpis that are in trend analysis
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - getCustomDates
```
public java.util.Date getCustomDates(boolean from)
                              throws MXException,
                                     java.rmi.RemoteException
```
    This method returns the custom trend dates related to this KPI from KPIGTRENDCFG, its configuration table
    
    Specified by:
    
    getCustomDates in interface KPIRemote
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
    
    See Also:
    
    psdi.app.kpi.KPIRemote#getCustomDates()
  - getTrendRange
```
public java.lang.String getTrendRange()
                               throws MXException,
                                      java.rmi.RemoteException
```
    Returns trend range based on what was selected by the user The values could be
    - 2WEEKS
    - 2YEARS
    - 3MONTHS
    - 5YEARS
    - 6MONTHS
    - MONTH
    - WEEK
    - YEAR
    Specified by:
    
    getTrendRange in interface KPIRemote
    
    Returns:
    
    range related to trend analysis of this KPI
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - validateTrendInfo
```
public void validateTrendInfo()
                       throws MXException,
                              java.rmi.RemoteException
```
    Validate whether trend information is correct for drawing chart and saving KPI.
    Range of start and end dates are validated for time range logic
    
    Specified by:
    
    validateTrendInfo in interface KPIRemote
    
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - delete
```
public void delete(long accessModifier)
            throws MXException,
                   java.rmi.RemoteException
```
    Description copied from class: Mbo
    
    Mark the object to be deleted depending on the access modifier. This will usually be overridden in the subclass of Mbo as there may be application specific rules as to if and when an object can be deleted. Object is not actually deleted in the database until save() is called. This method will also mark all associated Long Description and Translation Mbos for deletion.
    
    Specified by:
    
    delete in interface MboRemote
    
    Overrides:
    
    delete in class Mbo
    
    Parameters:
    
    accessModifier - 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)
  - isClearRelatedKPI
```
public boolean isClearRelatedKPI()
```
  - setClearRelatedKPI
```
public void setClearRelatedKPI(boolean clearRelatedKPI)
```
  - updateTrend
```
public void updateTrend()
                 throws java.rmi.RemoteException,
                        MXException
```
    Specified by:
    
    updateTrend in interface KPIRemote
    
    Throws:
    
    java.rmi.RemoteException
    
    MXException

Attribute Name	Attribute Value
IsPublic	True
KPIDate	Server Date
Format	DECIMAL
Real Time	Null
Last KPI Value	Null
Owner	Current user

Fields inherited from class psdi.mbo.Mbo

Fields inherited from interface psdi.mbo.MboConstants

Methods inherited from class psdi.mbo.Mbo

Methods inherited from class java.lang.Object

Methods inherited from interface psdi.mbo.MboRemote

KPI

add

run

validateSQL

save

duplicate

skipCopyField

canDelete

kpiInfo

getComparisionKPIs

getCustomDates

getTrendRange

validateTrendInfo

delete

isClearRelatedKPI

setClearRelatedKPI

updateTrend