com.aspc.knowledge.obj

Class KnowledgeSubGroup

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.knowledge.obj.KnowledgeSubGroup

All Implemented Interfaces:

SecondaryCacheGroup

public class KnowledgeSubGroup
extends DBObject

Knowledge Sub Group.

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

Since:

19 February 2013

Author:

Lei Gao

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 Sub Group
static java.lang.String	DBCLASS_NAME Knowledge Sub Group

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static KnowledgeSubGroup	create(MutableDataSource mds) Make a new instance of this class.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams inParams) displayMailCountry is linked and derived
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) OVERRIDE This method for all objects with derived fields that are NOT linked.
protected ValidationError	extValidateField(DBField field, ValidationList list) Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.
KnowledgeSubGroup	findHead(java.lang.String... args) The head KnowledgeSubGroup.
static KnowledgeSubGroup	findKey(DataSource ds, java.lang.String key) Find the target for this class by the primary key
KnowledgeSubGroup	findParent(java.lang.String... args) The parent KnowledgeSubGroup.
KnowledgeTopic	findTopic(java.lang.String... args) Deprecated.
java.lang.String	getCode(java.lang.String... args)
KnowledgeSubGroup	getHead(java.lang.String... args)
java.lang.String	getName(java.lang.String... args)
KnowledgeSubGroup	getParent(java.lang.String... args)
java.lang.String	getPath(java.lang.String... args)
int	getSequence(java.lang.String... args)
java.lang.String	getTargetWindow(java.lang.String... args)
KnowledgeTopic	getTopic(java.lang.String... args) Deprecated.
boolean	isInactive(java.lang.String... args)
static DBQuery<KnowledgeSubGroup>	makeQuery(DataSource ds) Make a new QUERY for this class.
KnowledgeSubGroup	setCode(java.lang.String value, java.lang.String... args)
KnowledgeSubGroup	setInactive(boolean value, java.lang.String... args)
KnowledgeSubGroup	setName(java.lang.String value, java.lang.String... args)
KnowledgeSubGroup	setParent(com.aspc.dal.knowledge.obj.KnowledgeSubGroup value, java.lang.String... args)
KnowledgeSubGroup	setSequence(int value, java.lang.String... args)
KnowledgeSubGroup	setTopic(com.aspc.dal.knowledge.obj.KnowledgeTopic value, java.lang.String... args) Deprecated.

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, eventFieldUpdated, extAutoEnterCreate, extCanDeleteDependantObject, extCheckCreateAccess, extCheckDeleteAccess, extCheckModifyAccess, extCheckModifyAccess, extCheckReadAccess, extCopy, extDelete, extDeleteRecord, extFixUp, extGetValue, extIsMandatory, extIsOnChange, extMarkSavePoint, extPostDeleteRecord, extPostSaveRecord, extPreDeleteRecord, extPreSaveRecord, extPreValidate, 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, makeSearchPlan, 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 Sub Group

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

Knowledge Sub Group

Constructor Detail

KnowledgeSubGroup

public KnowledgeSubGroup(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

getCode

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

setCode

@Nonnull
public KnowledgeSubGroup setCode(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getHead

@CheckReturnValue
 @Nullable
public KnowledgeSubGroup getHead(java.lang.String... args)

findHead

@CheckReturnValue
 @Nonnull
public final KnowledgeSubGroup findHead(java.lang.String... args)
                                                             throws NotFoundException

The head KnowledgeSubGroup.

--> KnowledgeSubGroup (String, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Knowledge Sub Group

Throws:

NotFoundException - KnowledgeSubGroup was not found

isInactive

@CheckReturnValue
public boolean isInactive(java.lang.String... args)

setInactive

@Nonnull
public KnowledgeSubGroup setInactive(boolean value,
                                              java.lang.String... args)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

getName

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

setName

@Nonnull
public KnowledgeSubGroup setName(java.lang.String value,
                                          java.lang.String... args)
                                   throws java.lang.Exception

Throws:

java.lang.Exception

getParent

@CheckReturnValue
 @Nullable
public KnowledgeSubGroup getParent(java.lang.String... args)

findParent

@CheckReturnValue
 @Nonnull
public final KnowledgeSubGroup findParent(java.lang.String... args)
                                                               throws NotFoundException

The parent KnowledgeSubGroup.

--> KnowledgeSubGroup (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Knowledge Sub Group

Throws:

NotFoundException - KnowledgeSubGroup was not found

setParent

@Nonnull
public KnowledgeSubGroup setParent(com.aspc.dal.knowledge.obj.KnowledgeSubGroup value,
                                            java.lang.String... args)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

getPath

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

getSequence

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

setSequence

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

Throws:

java.lang.Exception

getTargetWindow

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

getTopic

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

Deprecated.

findTopic

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

Deprecated.

Parent Topic of this Group.

--> KnowledgeTopic (String, Searchable)

Parameters:

args - the optional arguments

Returns:

KnowledgeTopic

Throws:

NotFoundException - KnowledgeTopic was not found

setTopic

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

Deprecated.

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static KnowledgeSubGroup 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<KnowledgeSubGroup> 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 KnowledgeSubGroup findKey(@Nonnull
                                                                    DataSource ds,
                                                                    @Nonnull
                                                                    java.lang.String 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

extValidateField

@CheckReturnValue
 @OverridingMethodsMustInvokeSuper
 @Nullable
protected ValidationError extValidateField(@Nonnull
                                                                                                           DBField field,
                                                                                                           @Nonnull
                                                                                                           ValidationList list)
                                                                                                    throws java.lang.Exception

Description copied from class: DBObject

Additional validation for particular field OVERRIDE THIS METHOD TO ADD VALIDATIONS FOR A FIELD.

OVERRIDE this method to add validation to a field but call iValidateField to perform the full validation for a field.

This method should be READ ONLY. Don't create DBObjects here.
When overriding this method the following code stub should be used.
ValidationError ve;
ve = super.extValidateField( field, list);
if( ve != null) return ve;
if( field.getName().equalsIgnoreCase( DBFIELD_FIELD1))
{
return list.createError( DBMessage.LIST_DB_MY_ERROR, this, field);
}
else if( field.getName().equalsIgnoreCase( DBFIELD_FIELD2))
{
....
}

Overrides:

extValidateField in class DBObject

Parameters:

field - The field to be validated

list - The validation list

Returns:

the error or warning.

Throws:

java.lang.Exception - a serious error

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 DBObject

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

extGetDerivedGlobalKey

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

displayMailCountry is linked and derived

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - The field

inParams - the field parameters

Returns:

The global key

Throws:

java.lang.Exception - A serious problem