psdi.app.kpi

Class KPITemplateMain

java.lang.Object

psdi.mbo.Mbo

psdi.app.kpi.KPITemplateMain

All Implemented Interfaces:

java.rmi.Remote, KPIVariableResolver, MboConstants, MboRemote, MaxRemoteProxy

public class KPITemplateMain
extends Mbo
implements MboRemote, KPIVariableResolver

KPITemplate is a template for generating KPI records using variables The key attribute for this object is:

The attributes in this object are as follows:

Author:

sls

Nested Class Summary

Nested classes/interfaces inherited from interface psdi.app.kpi.KPIVariableResolver

KPIVariableResolver.VariableData

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CAUTIONMAX The value where the indicators would change to a user-set color to indicate that the result of the KPI is in an alert stage. MAX TYPE: DECIMAL SAME AS: KPIMAIN.CAUTIONMAX
static java.lang.String	CAUTIONMIN The value where the indicators would change to a user-set color to indicate that the result of the KPI is in a caution stage.
static java.lang.String	ISACTIVE Maps to the KPIMAIN.REALTIME MAX TYPE: YORN SAME AS: KPIMAIN.REALTIME
static java.lang.String	ISPUBLIC Check this box to make the report available to all users who can run reports in the applicaton. MAX TYPE: YORN SAME AS: KPIMAIN.ISPUBLIC
static java.lang.String	KPITEMPLATEMAINID Unique Id MAX TYPE: BIGINT
static java.lang.String	KPITEMPLATEMAINNUM Template Main Id MAX TYPE: UPPER
static java.lang.String	KPITEMPLATENUM Template Name MAX TYPE: UPPER SAME AS: KPITEMPLATE.KPITEMPLATENUM
static java.lang.String	MBO_KPITEMPLATEMAIN
static java.lang.String	RELATIONSHIP_VALUES "KPITEMPLATEVARVALUES"
static java.lang.String	TARGET The target, or desired, value for the KPI. MAX TYPE: DECIMAL SAME AS: KPIMAIN.TARGET

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
KPITemplateMain(MboSet ms) Constructs the KPITemplateMain object.

Method Summary

Modifier and Type	Method and Description
void	add() Adds a new KPITemplate object.
MboRemote	copy(MboSetRemote mboset, long mboAddFlags) Adds a new mbo to the set passed in and copies the information for each of the fields into the new mbo from this.
void	delete(long accessModifier) override delete to delete this and records associated with KPITemplate
MboRemote	duplicate() Duplicate method only throws exception now
java.lang.String	findValueForVariable(MboSetRemote mboset, java.lang.String varname)
KPIVariableResolver.VariableData	getVariableData(java.lang.String variable) Get the Variable Data.
void	init() Initialization routine.
void	undelete() Unmark the Mbo for deletion.
java.lang.String	validateTemplate() Validates the current template, and returns the Query SQL, if valid.

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, canDelete, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copyFake, copyValue, copyValue, createComm, delete, 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, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, 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, setDefaultValue, setDefaultValues, setDeleted, 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, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, 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, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface psdi.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, 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, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, unlock, unselect, validate, validateAttributes

Field Detail

MBO_KPITEMPLATEMAIN

public static final java.lang.String MBO_KPITEMPLATEMAIN

See Also:

Constant Field Values

CAUTIONMAX

public static final java.lang.String CAUTIONMAX

The value where the indicators would change to a user-set color to indicate that the result of the KPI is in an alert stage.
MAX TYPE: DECIMAL
SAME AS: KPIMAIN.CAUTIONMAX

See Also:

Constant Field Values

CAUTIONMIN

public static final java.lang.String CAUTIONMIN

The value where the indicators would change to a user-set color to indicate that the result of the KPI is in a caution stage. Note: If the Caution At value is greater than the Alert At value, the direction of the KPI will change to indicate that a higher number is more ideal than a lower number.
MAX TYPE: DECIMAL
SAME AS: KPIMAIN.CAUTIONMIN

See Also:

Constant Field Values

ISACTIVE

public static final java.lang.String ISACTIVE

Maps to the KPIMAIN.REALTIME
MAX TYPE: YORN
SAME AS: KPIMAIN.REALTIME

See Also:

Constant Field Values

ISPUBLIC

public static final java.lang.String ISPUBLIC

Check this box to make the report available to all users who can run reports in the applicaton.
MAX TYPE: YORN
SAME AS: KPIMAIN.ISPUBLIC

See Also:

Constant Field Values

KPITEMPLATEMAINID

public static final java.lang.String KPITEMPLATEMAINID

Unique Id
MAX TYPE: BIGINT

See Also:

Constant Field Values

KPITEMPLATEMAINNUM

public static final java.lang.String KPITEMPLATEMAINNUM

Template Main Id
MAX TYPE: UPPER

See Also:

Constant Field Values

KPITEMPLATENUM

public static final java.lang.String KPITEMPLATENUM

Template Name
MAX TYPE: UPPER
SAME AS: KPITEMPLATE.KPITEMPLATENUM

See Also:

Constant Field Values

TARGET

public static final java.lang.String TARGET

The target, or desired, value for the KPI.
MAX TYPE: DECIMAL
SAME AS: KPIMAIN.TARGET

See Also:

Constant Field Values

RELATIONSHIP_VALUES

public static final java.lang.String RELATIONSHIP_VALUES

"KPITEMPLATEVARVALUES"

See Also:

Constant Field Values

Constructor Detail

KPITemplateMain

public KPITemplateMain(MboSet ms)
                throws MXException,
                       java.rmi.RemoteException

Constructs the KPITemplateMain object.

Parameters:

ms - MboSet

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Initialization routine. Set the fields to read/write mode conditionally

Overrides:

init in class Mbo

Parameters:

none -

Throws:

none

MXException

add

public void add()
         throws MXException,
                java.rmi.RemoteException

Adds a new KPITemplate object. This is called when a new Mbo is added to the Mboset collection. It is called AFTER user defaults have been set from the data dictionary. Programmer should usually override this to set some defaults.

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Parameters:

none -

Throws:

MXException - , RemoteException

java.rmi.RemoteException

delete

public void delete(long accessModifier)
            throws MXException,
                   java.rmi.RemoteException

override delete to delete this and records associated with KPITemplate

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 - , RemoteException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

undelete

public void undelete()
              throws MXException,
                     java.rmi.RemoteException

Description copied from class: Mbo

Unmark the Mbo for deletion. Can only be called after a delete() and before the save() has been performed. This method will also unmark associated Long Description and Translation Mbos.

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

validateTemplate

public java.lang.String validateTemplate()
                                  throws java.rmi.RemoteException,
                                         MXException

Validates the current template, and returns the Query SQL, if valid.

Returns:

Throws:

java.rmi.RemoteException

MXException

getVariableData

public KPIVariableResolver.VariableData getVariableData(java.lang.String variable)
                                                 throws MXException,
                                                        java.rmi.RemoteException

Description copied from interface: KPIVariableResolver

Get the Variable Data. Throw MXException if the data is not found

Specified by:

getVariableData in interface KPIVariableResolver

Parameters:

variable - Variable Name

Returns:

KPIVariableResolver.VariableData structure

Throws:

MXException - if no data is found for the given variable

java.rmi.RemoteException

duplicate

public MboRemote duplicate()
                    throws MXException,
                           java.rmi.RemoteException

Description copied from class: Mbo

Duplicate method only throws exception now

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Throws:

MXException

java.rmi.RemoteException

copy

public MboRemote copy(MboSetRemote mboset,
                      long mboAddFlags)
               throws MXException,
                      java.rmi.RemoteException

Description copied from class: Mbo

Adds a new mbo to the set passed in and copies the information for each of the fields into the new mbo from this. The new mbo will be added to the next of the current index.

Specified by:

copy in interface MboRemote

Overrides:

copy in class Mbo

Parameters:

mboset - The set into which the new mbo will be added.

mboAddFlags - Flags to use when adding the new Mbo. Values on the attribute are always set with NOACCESSCHECK|NOVALIDATION_AND_NOACTION.

Returns:

The new mbo, with values copied from this mbo.

Throws:

MXException

java.rmi.RemoteException

findValueForVariable

public java.lang.String findValueForVariable(MboSetRemote mboset,
                                             java.lang.String varname)
                                      throws java.rmi.RemoteException,
                                             MXException

Throws:

java.rmi.RemoteException

MXException