psdi.app.kpi

Class KPITemplate

java.lang.Object

psdi.mbo.Mbo

psdi.app.kpi.KPITemplate

All Implemented Interfaces:

java.rmi.Remote, MboConstants, MboRemote, MaxRemoteProxy

public class KPITemplate
extends Mbo
implements MboRemote

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:

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APP Application on which this KPI is based on MAX TYPE: UPPER SAME AS: KPIMAIN.APP FIELD CLASS: psdi.app.kpi.FldAppName
static java.lang.String	CREATEDDATE Created Date MAX TYPE: DATETIME SAME AS: KPIMAIN.LASTUPDATED
static java.lang.String	DESCRIPTION Template Description MAX TYPE: ALN
static java.lang.String	DESCRIPTION_LONGDESCRIPTION Long Description for Description MAX TYPE: LONGALN
static java.lang.String	FORMAT Indicates whether the KPI is decimal or percentage based. MAX TYPE: UPPER SAME AS: KPIMAIN.FORMAT
static java.lang.String	HASLD Boolean flag to indicate if there is any long description for this record MAX TYPE: YORN
static java.lang.String	KPITEMPLATEID Unique Id MAX TYPE: BIGINT
static java.lang.String	KPITEMPLATENUM Template Id MAX TYPE: UPPER
static java.lang.String	LANGCODE Language Code MAX TYPE: UPPER SAME AS: LANGUAGE.MAXLANGCODE FIELD CLASS: psdi.app.system.FldLangCode
static java.lang.String	MBO_KPITEMPLATE
static java.lang.String	OWNER The name of the person who created the KPI. MAX TYPE: UPPER SAME AS: PERSON.PERSONID
static java.lang.String	QUERY KPI Template Query MAX TYPE: ALN
static java.lang.String	RELATIONSHIP_ALL_KPIS "ALLKPIS"
static java.lang.String	RELATIONSHIP_EXISTING_KPIS "KPITEMPLATES"
static java.lang.String	RELATIONSHIP_KPIS "KPITEMPLATEMAINS"
static java.lang.String	RELATIONSHIP_VARIABLES "KPITEMPLATEVARS"
static java.lang.String	REVISEDBY Revised By MAX TYPE: UPPER SAME AS: PERSON.PERSONID
static java.lang.String	REVISEDDATE Last Updated Date MAX TYPE: DATETIME SAME AS: KPIMAIN.LASTUPDATED
static java.lang.String	TRENDBATCHSIZE Batch Size of Trend Value MAX TYPE: INTEGER SAME AS: KPIMAIN.TRENDBATCHSIZE
static java.lang.String	TRENDENABLED Enable Trend Value MAX TYPE: YORN SAME AS: KPIMAIN.TRENDENABLED

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

Method Summary

Modifier and Type	Method and Description
void	add() Adds a new KPITemplate object.
void	delete(long accessModifier) override delete to delete this and records associated with KPITemplate
MboRemote	duplicate() Duplicate method only throws exception now
void	init() Initialization routine.
void	save() Saves a KPITemplate object.
protected boolean	skipCopyField(MboValueInfo mvi)
void	undelete() Unmark the Mbo for deletion.
void	validateQuery()

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, canDelete, 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, 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, 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, unlock, unselect, validate, validateAttributes

Field Detail

MBO_KPITEMPLATE

public static final java.lang.String MBO_KPITEMPLATE

See Also:

Constant Field Values

APP

public static final java.lang.String APP

Application on which this KPI is based on
MAX TYPE: UPPER
SAME AS: KPIMAIN.APP
FIELD CLASS: psdi.app.kpi.FldAppName

See Also:

Constant Field Values

CREATEDDATE

public static final java.lang.String CREATEDDATE

Created Date
MAX TYPE: DATETIME
SAME AS: KPIMAIN.LASTUPDATED

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

Template Description
MAX TYPE: ALN

See Also:

Constant Field Values

DESCRIPTION_LONGDESCRIPTION

public static final java.lang.String DESCRIPTION_LONGDESCRIPTION

Long Description for Description
MAX TYPE: LONGALN

See Also:

Constant Field Values

FORMAT

public static final java.lang.String FORMAT

Indicates whether the KPI is decimal or percentage based.
MAX TYPE: UPPER
SAME AS: KPIMAIN.FORMAT

See Also:

Constant Field Values

HASLD

public static final java.lang.String HASLD

Boolean flag to indicate if there is any long description for this record
MAX TYPE: YORN

See Also:

Constant Field Values

KPITEMPLATEID

public static final java.lang.String KPITEMPLATEID

Unique Id
MAX TYPE: BIGINT

See Also:

Constant Field Values

KPITEMPLATENUM

public static final java.lang.String KPITEMPLATENUM

Template Id
MAX TYPE: UPPER

See Also:

Constant Field Values

LANGCODE

public static final java.lang.String LANGCODE

Language Code
MAX TYPE: UPPER
SAME AS: LANGUAGE.MAXLANGCODE
FIELD CLASS: psdi.app.system.FldLangCode

See Also:

Constant Field Values

OWNER

public static final java.lang.String OWNER

The name of the person who created the KPI.
MAX TYPE: UPPER
SAME AS: PERSON.PERSONID

See Also:

Constant Field Values

QUERY

public static final java.lang.String QUERY

KPI Template Query
MAX TYPE: ALN

See Also:

Constant Field Values

REVISEDBY

public static final java.lang.String REVISEDBY

Revised By
MAX TYPE: UPPER
SAME AS: PERSON.PERSONID

See Also:

Constant Field Values

REVISEDDATE

public static final java.lang.String REVISEDDATE

Last Updated Date
MAX TYPE: DATETIME
SAME AS: KPIMAIN.LASTUPDATED

See Also:

Constant Field Values

TRENDENABLED

public static final java.lang.String TRENDENABLED

Enable Trend Value
MAX TYPE: YORN
SAME AS: KPIMAIN.TRENDENABLED

See Also:

Constant Field Values

TRENDBATCHSIZE

public static final java.lang.String TRENDBATCHSIZE

Batch Size of Trend Value
MAX TYPE: INTEGER
SAME AS: KPIMAIN.TRENDBATCHSIZE

See Also:

Constant Field Values

RELATIONSHIP_VARIABLES

public static final java.lang.String RELATIONSHIP_VARIABLES

"KPITEMPLATEVARS"

See Also:

Constant Field Values

RELATIONSHIP_KPIS

public static final java.lang.String RELATIONSHIP_KPIS

"KPITEMPLATEMAINS"

See Also:

Constant Field Values

RELATIONSHIP_EXISTING_KPIS

public static final java.lang.String RELATIONSHIP_EXISTING_KPIS

"KPITEMPLATES"

See Also:

Constant Field Values

RELATIONSHIP_ALL_KPIS

public static final java.lang.String RELATIONSHIP_ALL_KPIS

"ALLKPIS"

See Also:

Constant Field Values

Constructor Detail

KPITemplate

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

Constructs the KPITemplate 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

save

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

Saves a KPITemplate object.

Overrides:

save in class Mbo

Parameters:

none -

Throws:

none

MXException

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

validateQuery

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

Throws:

MXException

java.rmi.RemoteException

skipCopyField

protected boolean skipCopyField(MboValueInfo mvi)
                         throws java.rmi.RemoteException,
                                MXException

Overrides:

skipCopyField in class Mbo

Throws:

java.rmi.RemoteException

MXException

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