psdi.app.knowledgebase

Class KB

java.lang.Object

psdi.mbo.Mbo

psdi.app.knowledgebase.KB

All Implemented Interfaces:

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

public class KB
extends Mbo
implements KBRemote

MBO representing a KnowledgeBase Article The attributes in this object are as follows:

Attribute Name	Description
ARTICLEID	Article ID. This is the unique identifier of the Article record.
DESCRIPTION	This is the main description of the knowledge base article.
STATE	This identifies the state of the article. The valid states are ACTIVE, INACTIVE and DRAFT. Only ACTIVE Articles can be used by end users. INACTIVE and DRAFTS are managed by administrators.
TYPE	This can be used to define types of articles. No value list out of the box, but customers could create one if desired.
KEYWORDS	This is where keywords are defined to describe the contents of the article. Keyword searching will utilize this field. Separate each individual keyword with a space.
STARTDATE	This is the start of the effective date range of the article. A null start date indicates that there was no specific start date. A null end date indicates there is no specific end date. When both are null, it will indicate there are no effective dates and the article is always 'effective'.
ENDDATE	This is the end of the effective date range of the article. A null start date indicates that there was no specific start date. A null end date indicates there is no specific end date. When both are null, it will indicate there are no effective dates and the article is always 'effective'.
SYMPTOM	This is the description of the known or observed symptoms.
CAUSE	This is the description of the known or observed cause of the symptoms.
RESOLUTION	This is the description of the resolution required to address a symptom/cause
SUMMARY	This field is a brief summary of the Article content.
MOREINFORMATION	This field contains any additional information for the Article.
WORKAROUND	This field defines any work around information that may be necessary until the problem can be resolved.
CONTENTSOURCE	This defines where the content of the article came from. This may be anything from a person, organization or a book to a web page or industry standard.
PAGEVIEWCOUNT	The UI will determine when a page view occurs. The UI will then need to call a function that increases this page count value.
RANKINGCOUNT	This is the number of times the Article has been ranked for usefulness by an end user. This value is only increased when a usefulness ranking occurs. The action to calculate the new average rank will update this value.
AVGUSEFULRANK	This is the Average Usefulness of the Article based on user rankings. A 0 value means no one has ranked it yet or everyone who has ranked it has ranked it as 0. A RANKINGCOUNT of 0 means no rankings have occurredThe average rank will be calculated as follows: New AVGUSEFULRANK = ((Old AVGUSEFULRANK * Old RANKINGCOUNT) + (New AVGUSEFULRANK)) (Old RANKINGCOUNT + 1)New RANKINGCOUNT = Old RANKINGCOUNT +1
LASTREVIEWEDBY	This is the person who last reviewed the Article.
LASTREVIEWEDDATE	This is the Date and Time that the Article was last reviewed.
CHANGEBY	This is the user who last modified the Article.
CHANGEDATE	This is when the Article was last modified.

Author:

Sach Balagopalan

Field Summary

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface psdi.app.knowledgebase.KBRemote

KBLINKED

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
KB(MboSet ms) Construct the KB Object

Method Summary

Methods

Modifier and Type

Method and Description

void

add() Add a new Article The following fields are initialized with their respective values pageviewcount 0 (zero) rankingcount 0 (zero) avgusefulrank 0 (zero) changeby Current username changedate Current Date startdate Current Date void delete() If an article is deleted then make sure all associated linked articles are deleted MboRemote duplicate() Creates a duplicate KBArticle with its related objects. int getAverageUsefulRank() Get the Average Useful Rank int getPageViewCount() Get the Page View Count int getTicketUseCount() Get the Page View Count void increasePageViewCount() Increase the PageView Count by 1 Call this method whenever an article is selected for viewing/updating void increasePageViewCount(int count) Increase the PageView Count by the int value arg. void increaseTicketUseCount() Increase the Ticket use Count by 1 Call this method whenever an article is applied to a ticket void increaseTicketUseCount(int count) Increase the TicketUse Count by the int value arg. void init() Initialize the KB object boolean isEndDateValid() Validate End Date boolean isStartDateValid() Validate Start Date void save() Save Article The following fields are set on save with their respective values changeby Current username changedate Current Date void updateAverageUsefulRank(double newrank) Update the Average Useful rank and increase the RankCount by 1 Called whenever a user Ranks an article Methods inherited from class psdi.mbo.Mbo addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, canDelete, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, 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, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getRowRestrictionFlag, getRowStamp, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeRelatedSet, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, setEAuditFieldModified, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setReferencedMbo, setReferencedMbo, 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, undelete, 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, 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, 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, undelete, unlock, unselect, validate, validateAttributes Constructor Detail KB public KB(MboSet ms) throws java.rmi.RemoteException Construct the KB Object Parameters: MboSet - - Instance of MboSet Throws: java.rmi.RemoteException Method Detail init public void init() throws MXException Initialize the KB object Overrides: init in class Mbo Throws: MXException add public void add() throws java.rmi.RemoteException, MXException Add a new Article The following fields are initialized with their respective values pageviewcount 0 (zero) rankingcount 0 (zero) avgusefulrank 0 (zero) changeby Current username changedate Current Date startdate Current Date Specified by: add in interface MboRemote Overrides: add in class Mbo Throws: java.rmi.RemoteException MXException save public void save() throws java.rmi.RemoteException, MXException Save Article The following fields are set on save with their respective values changeby Current username changedate Current Date Throws: java.rmi.RemoteException MXException increaseTicketUseCount public void increaseTicketUseCount() throws MXException, java.rmi.RemoteException Increase the Ticket use Count by 1 Call this method whenever an article is applied to a ticket Specified by: increaseTicketUseCount in interface KBRemote Throws: MXException java.rmi.RemoteException See Also: increaseTicketUseCount() increaseTicketUseCount public void increaseTicketUseCount(int count) throws MXException, java.rmi.RemoteException Increase the TicketUse Count by the int value arg. Specified by: increaseTicketUseCount in interface KBRemote Parameters: int - - Count to increase the TicketUseCount by Throws: MXException java.rmi.RemoteException See Also: increaseTicketUseCount(int count) getTicketUseCount public int getTicketUseCount() throws MXException, java.rmi.RemoteException Get the Page View Count Returns: int - Return the pageviewcount as an int Throws: MXException java.rmi.RemoteException increasePageViewCount public void increasePageViewCount() throws MXException, java.rmi.RemoteException Increase the PageView Count by 1 Call this method whenever an article is selected for viewing/updating Specified by: increasePageViewCount in interface KBRemote Throws: MXException java.rmi.RemoteException See Also: increasePageViewCount() increasePageViewCount public void increasePageViewCount(int count) throws MXException, java.rmi.RemoteException Increase the PageView Count by the int value arg. Specified by: increasePageViewCount in interface KBRemote Parameters: int - - Count to increase the PageViewCount by Throws: MXException java.rmi.RemoteException See Also: increasePageViewCount(int i) getPageViewCount public int getPageViewCount() throws MXException, java.rmi.RemoteException Get the Page View Count Specified by: getPageViewCount in interface KBRemote Returns: int - Return the pageviewcount as an int Throws: MXException java.rmi.RemoteException See Also: getPageViewCount() updateAverageUsefulRank public void updateAverageUsefulRank(double newrank) throws MXException, java.rmi.RemoteException Update the Average Useful rank and increase the RankCount by 1 Called whenever a user Ranks an article Specified by: updateAverageUsefulRank in interface KBRemote Parameters: double - - New rank value Throws: MXException java.rmi.RemoteException See Also: updateAverageUsefulRank(double newrank) getAverageUsefulRank public int getAverageUsefulRank() throws MXException, java.rmi.RemoteException Get the Average Useful Rank Returns: int - Return the Average Useful Rank Throws: MXException java.rmi.RemoteException isStartDateValid public boolean isStartDateValid() throws MXException, java.rmi.RemoteException Validate Start Date Specified by: isStartDateValid in interface KBRemote Returns: boolean - Return true or false Throws: MXException java.rmi.RemoteException See Also: isStartDateValid() isEndDateValid public boolean isEndDateValid() throws MXException, java.rmi.RemoteException Validate End Date Specified by: isEndDateValid in interface KBRemote Returns: boolean - Return true or false Throws: MXException java.rmi.RemoteException See Also: isEndDateValid() duplicate public MboRemote duplicate() throws MXException, java.rmi.RemoteException Creates a duplicate KBArticle with its related objects. Specified by: duplicate in interface MboRemote Overrides: duplicate in class Mbo Returns: the newly duplicated MboRemote article Throws: MXException java.rmi.RemoteException See Also: psdi.mbo.Mbo#isAutoKeyed. delete public void delete() throws MXException, java.rmi.RemoteException If an article is deleted then make sure all associated linked articles are deleted Specified by: delete in interface MboRemote Overrides: delete in class Mbo Throws: MXException java.rmi.RemoteException See Also: Mbo.delete(long) Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method