com.aspc.knowledge.obj

Class KnowledgeArticle

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.cms.article.ArticleTemplate

com.aspc.knowledge.obj.KnowledgeArticle

All Implemented Interfaces:

SecondaryCacheGroup

public class KnowledgeArticle
extends ArticleTemplate

Knowledge Article.

data model
THREAD MODE: MIXED, SINGLE-THREADED when called from MutableDataSource else MULTI-THREADED

Since:

4 December 2003

Author:

Nigel Leck

Nested Class Summary

Nested classes/interfaces inherited from class com.aspc.DBObj.DBObject

DBObject.DenormalizeAction

Field Summary

Fields

Modifier and Type	Field and Description
static GlobalId	DBCLASS_GID Knowledge Article
static java.lang.String	DBCLASS_NAME Knowledge Article

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

Constructor and Description
KnowledgeArticle(DBClass def, DataSource dataSource) Std.

Method Summary

Modifier and Type	Method and Description
static KnowledgeArticle	create(MutableDataSource mds) Make a new instance of this class.
org.w3c.dom.Element	createRSS(org.w3c.dom.Document doc, java.lang.String serverURL, java.util.HashMap<java.lang.String,java.lang.String> params)
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) OVERRIDE This method to return a derived global key.
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected void	extPreValidate() Update the in-memory universe BEFORE validating
static KnowledgeArticle	findKey(DataSource ds, int key) Find the target for this class by the primary key
KnowledgeTopic	findOldTopic(java.lang.String... args) Deprecated.
java.lang.String	getAnswerHTML(java.lang.String... args)
java.lang.String	getGroupName(java.lang.String... args)
java.util.List<KnowledgeSubGroup>	getHead(java.lang.String... args)
KnowledgeTopic	getOldTopic(java.lang.String... args) Deprecated.
int	getSequence(java.lang.String... args)
java.util.List<KnowledgeSubGroup>	getSubGroup(java.lang.String... args)
java.util.List<KnowledgeSubGroup>	getTopic(java.lang.String... args)
java.lang.String	getTopicLabel(java.lang.String... args)
java.lang.String	getTopicPaths(java.lang.String... args)
static DBQuery<KnowledgeArticle>	makeQuery(DataSource ds) Make a new QUERY for this class.
static SearchPlan	makeSearchPlan(DBQuery<DBObject> query) A special plan for Exclude.
protected java.lang.String	makeSearchText()
KnowledgeArticle	setAnswerHTML(java.lang.String value, java.lang.String... args)
KnowledgeArticle	setOldTopic(com.aspc.dal.knowledge.obj.KnowledgeTopic value, java.lang.String... args) Deprecated.
KnowledgeArticle	setSequence(int value, java.lang.String... args)
KnowledgeArticle	setSubGroup(java.util.List<KnowledgeSubGroup> value, java.lang.String... args)

Methods inherited from class com.aspc.cms.article.ArticleTemplate

correctHTML, eventFieldUpdated, extPreDeleteRecord, extPreSaveRecord, extValidateField, findAuthor, findBanner, findChannel, findDefaultDistributionEmailTemplate, findEdition, findStatus, findStatusIcon, generatePath, getArchiveTS, getAuthor, getAuthorName, getBanner, getChannel, getCorrectionTS, getDefaultDistributionEmailTemplate, getDerivedChannels, getEdition, getID, getPath, getPublishedTS, getRawSearchText, getSeq, getShortSummary, getStatus, getStatusIcon, getSubTitle, getSummary, getTags, getTagsRaw, getTextSummary, getTitle, getUpdatedTS, getUUID, isDistribute, isPublished, makeDateElement, offline, publish, setAuthor, setBanner, setChannel, setCorrectionTS, setDistribute, setEdition, setID, setPath, setPublished, setPublishedTS, setRawSearchText, setSeq, setSubTitle, setTags, setTagsRaw, setTitle, setUpdatedTS, setUseArchiveVersion, useArchiveVersion

Methods inherited from class com.aspc.DBObj.DBObject

addReloadEventListener, archiveCheck, autoEnterCreate, calculateValue, calculateValue, calculateValue, callingRestoreByJournal, changeThreadMode, checkCreateAccess, checkDelete, checkDeleteAccess, checkModifyAccess, checkModifyAccess, checkReadAccess, clearCache, copy, copyFields, copyIncludeField, copyInwardLinks, delete, denormalizedResult, displayLogName, displayName, displayValue, doSearch, dump, equals, eventDataLoaded, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreValidateDelete, extRaiseEvents, extRollbackTo, extSaveRecord, extSetValue, extUndelete, extValidateDelete, extValidateRecord, fetchLinkHolder, findGlobalKey, findGlobalKey, findGlobalKey, findGlobalKey, findLinkedObject, findLinkedObject, findLinkedObject, findRawData, fireEventDataLoaded, fixUp, forceLockedTransaction, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getBoolean, getChangedFieldInfo, getChangedFields, getDate, getDate, getDate, getDate, getDate, getDefaultValue, getDisableOnChangeEvent, getDouble, getDouble, getDouble, getDouble, getDouble, getFieldDouble, getFieldInt, getFieldLong, getFieldString, getFormattedString, getFormattedString, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getGlobalKey, getInt, getInt, getInt, getInt, getInt, getInt, getInwardLinkage, getKeyString, getKeyValue, getLinkedObject, getLinkedObject, getLinkedObject, getLinkedObjectByKey, getLinkedRowId, getLinkedRowId, getLinkedRowIdByData, getLinkHolder, getLockedTransaction, getLong, getLong, getLong, getLong, getLong, getLong, getMutableArrayValue, getMutableArrayValue, getOriginalKey, getOriginalValue, getOriginalValue, getProcessedValue, getPureValue, getRawData, getRawValue, getRawValue, getRowId, getRowKey, getSecondaryCacheGroupKey, getSrcLayerID, getString, getString, getString, getString, getString, getString, getValue, getValue, getValue, getValue, hasAutoChanged, hasAutoChanged, hasChanged, hasChangedByUser, hasChangedByUserField, hasChangedByUserField, hasFieldChanged, hasFieldChanged, hashCode, hasStoredResult, iCheckDeleteAccess, iCheckModifyAccess, iCheckReadAccess, iGetDenormalizedMap, iGetRawValue, iPlaceDenormalizedResult, iPostSaveOrDeleteRecord, iPreSaveOrDeleteRecord, iPreValidate, iRaiseEvents, iSaveOrDeleteRecord, isBrokenLink, isBrokenLink, isChanged, isDataCacheKnownToBeDirty, isDeleted, isEmpty, iSetValue, isForceReindex, isKeyWordField, isMandatory, isNew, isNull, isNull, isOnChange, isReindex, iValidateRecord, lastTouched, makeArchiveDataLoader, makeClone, makeDataLoader, makeDenormalizedDoc, makeLinkedArray, makeModifyAccessException, makeWriteProvider, manualDenormalizeOnSave, markSavePoint, optLockedTransaction, registerWatchedObject, reindex, releaseDenormalized, removeReloadEventListener, restoreByJournal, rollbackTo, setBoolean, setBoolean, setBoolean, setBoolean, setDisableOnChangeEvent, setDouble, setDouble, setInt, setInt, setLong, setLong, setRawData, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, touch, undelete, validateField, validateRecord, validateSubType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DBCLASS_NAME

public static final java.lang.String DBCLASS_NAME

Knowledge Article

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Knowledge Article

Constructor Detail

KnowledgeArticle

public KnowledgeArticle(DBClass def,
                        DataSource dataSource)
                 throws java.lang.Exception

Std. DBObject constructor

Parameters:

def - The class of this object

dataSource - The datasource for this object

Throws:

java.lang.Exception - A serious problem occurred

Method Detail

getAnswerHTML

@CheckReturnValue
 @Nonnull
public java.lang.String getAnswerHTML(java.lang.String... args)

setAnswerHTML

@Nonnull
public KnowledgeArticle setAnswerHTML(java.lang.String value,
                                               java.lang.String... args)
                                        throws java.lang.Exception

Throws:

java.lang.Exception

getGroupName

@CheckReturnValue
 @Nonnull
public java.lang.String getGroupName(java.lang.String... args)

getHead

@CheckReturnValue
 @Nonnull
public java.util.List<KnowledgeSubGroup> getHead(java.lang.String... args)

getOldTopic

@Deprecated
 @CheckReturnValue
 @Nullable
public KnowledgeTopic getOldTopic(java.lang.String... args)

Deprecated.

findOldTopic

@CheckReturnValue
 @Deprecated
 @Nonnull
public final KnowledgeTopic findOldTopic(java.lang.String... args)
                                                                           throws NotFoundException

Deprecated.

The topic for this article.

--> KnowledgeTopic (String, Searchable)

Parameters:

args - the optional arguments

Returns:

KnowledgeTopic

Throws:

NotFoundException - KnowledgeTopic was not found

setOldTopic

@Deprecated
 @Nonnull
public KnowledgeArticle setOldTopic(com.aspc.dal.knowledge.obj.KnowledgeTopic value,
                                                          java.lang.String... args)
                                                   throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getSequence

@CheckReturnValue
public int getSequence(java.lang.String... args)

setSequence

@Nonnull
public KnowledgeArticle setSequence(int value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getSubGroup

@CheckReturnValue
 @Nonnull
public java.util.List<KnowledgeSubGroup> getSubGroup(java.lang.String... args)

setSubGroup

@Nonnull
public KnowledgeArticle setSubGroup(java.util.List<KnowledgeSubGroup> value,
                                             java.lang.String... args)
                                      throws java.lang.Exception

Throws:

java.lang.Exception

getTopic

@CheckReturnValue
 @Nonnull
public java.util.List<KnowledgeSubGroup> getTopic(java.lang.String... args)

getTopicLabel

@CheckReturnValue
 @Nonnull
public java.lang.String getTopicLabel(java.lang.String... args)

getTopicPaths

@CheckReturnValue
 @Nonnull
public java.lang.String getTopicPaths(java.lang.String... args)

create

@Nonnull
 @CheckReturnValue
public static KnowledgeArticle create(@Nonnull
                                                                  MutableDataSource mds)
                                                           throws java.lang.Exception

Make a new instance of this class.

Parameters:

mds - the datasource

Returns:

the new record

Throws:

java.lang.Exception - an object of this class could not be created

makeQuery

@Nonnull
 @CheckReturnValue
public static DBQuery<KnowledgeArticle> makeQuery(@Nonnull
                                                                              DataSource ds)
                                                                       throws NotFoundException

Make a new QUERY for this class.

Parameters:

ds - the datasource

Returns:

the new QUERY

Throws:

NotFoundException - if class could not be found

findKey

@Nonnull
 @CheckReturnValue
public static KnowledgeArticle findKey(@Nonnull
                                                                   DataSource ds,
                                                                   int key)
                                                            throws NotFoundException,
                                                                   java.lang.Exception

Find the target for this class by the primary key

Parameters:

ds - the datasource

key - the value

Returns:

the target

Throws:

NotFoundException - if target could not be found

java.lang.Exception - a serious problem

makeSearchPlan

@CheckReturnValue
 @Nonnull
public static SearchPlan makeSearchPlan(@Nonnull
                                                                    DBQuery<DBObject> query)

A special plan for Exclude.

Parameters:

query - The query for it's search

Returns:

The search plan

extGetDerivedGlobalKey

@CheckReturnValue
 @Nullable
protected GlobalKey extGetDerivedGlobalKey(@Nonnull
                                                                        DBField field,
                                                                        @Nullable
                                                                        FldParams params)
                                                                 throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method to return a derived global key. This method is only checked if the field is marked as being linked.

Overrides:

extGetDerivedGlobalKey in class ArticleTemplate

Parameters:

field - The field that is being changed

params - The extra parameters

Returns:

The Global key

Throws:

java.lang.Exception - A serious problem. In general validation is done later.

extGetDerivedValue

@CheckReturnValue
protected java.lang.Object extGetDerivedValue(@Nonnull
                                                                DBField field,
                                                                @Nullable
                                                                FldParams params)
                                                         throws java.lang.Exception

Description copied from class: DBObject

OVERRIDE This method for all objects with derived fields that are NOT linked. A linked derived field should extend the extGetDerivedGlobalKey.

Overrides:

extGetDerivedValue in class ArticleTemplate

Parameters:

field - The field to get

params - The parameters for this field eg. language= or default=

Returns:

The value of the field.

Throws:

java.lang.Exception - a serious problem

createRSS

public org.w3c.dom.Element createRSS(org.w3c.dom.Document doc,
                                     java.lang.String serverURL,
                                     java.util.HashMap<java.lang.String,java.lang.String> params)
                              throws java.lang.Exception

Overrides:

createRSS in class ArticleTemplate

Throws:

java.lang.Exception

extPreValidate

@OverridingMethodsMustInvokeSuper
protected void extPreValidate()
                                                         throws java.lang.Exception

Description copied from class: ArticleTemplate

Update the in-memory universe BEFORE validating

Overrides:

extPreValidate in class ArticleTemplate

Throws:

java.lang.Exception - A serious problem

makeSearchText

protected java.lang.String makeSearchText()
                                   throws java.lang.Exception

Overrides:

makeSearchText in class ArticleTemplate

Throws:

java.lang.Exception