com.aspc.DBObj

Class DBLog

java.lang.Object

com.aspc.DBObj.DBObject

com.aspc.DBObj.DBLog

All Implemented Interfaces:

SecondaryCacheGroup

Direct Known Subclasses:

ClientScriptErrorLog, DBAlertLog, DBFileStoreLog, DBJobManagerLog, RestDeprecatedErrorLog

public class DBLog
extends DBObject

store messages for an error.

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

Since:

November 1, 2005

Author:

luke

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 store messages for an error
static java.lang.String	DBCLASS_NAME store messages for an error

Fields inherited from class com.aspc.DBObj.DBObject

ATTRIBUTE_MARVIN, dbClass, ds, NO_LOOP_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static DBLog	create(MutableDataSource mds) Make a new instance of this class.
protected GlobalKey	extGetDerivedGlobalKey(DBField field, FldParams params) Gets a derived global key for the given field
protected java.lang.Object	extGetDerivedValue(DBField field, FldParams params) Gets a derived value for a field that is not a key or linked object
static DBLog	findKey(DataSource ds, int key) Find the target for this class by the primary key
DBMessageType	findLevel(java.lang.String... args) The level of message, i.e Warning, Stop --> DBMessageType (String, Searchable)
Person	findPerson(java.lang.String... args) User, linked to Person, derived.
int	getID(java.lang.String... args)
DBMessageType	getLevel(java.lang.String... args)
java.lang.String	getMessage(java.lang.String... args)
Person	getPerson(java.lang.String... args)
java.lang.String	getPersonKey(java.lang.String... args)
java.lang.String	getPersonName(java.lang.String... args)
java.lang.String	getSessionId(java.lang.String... args) Deprecated.
java.lang.String	getSummaryHTML(java.lang.String... args)
java.util.Date	getTime(java.lang.String... args)
static void	logError(java.lang.String msg, DataSource ds) Logs an error with DBFIELD_LEVEL set to ERROR
protected java.lang.String	makeHeadLine()
static DBQuery<DBLog>	makeQuery(DataSource ds) Make a new QUERY for this class.
protected HTMLPanel	makeSummary()
DBLog	setID(int value, java.lang.String... args)
DBLog	setLevel(com.aspc.dal.message.DBMessageType value, java.lang.String... args)
DBLog	setMessage(java.lang.String value, java.lang.String... args)
DBLog	setPersonKey(java.lang.String value, java.lang.String... args)
DBLog	setSessionId(java.lang.String value, java.lang.String... args) Deprecated.
DBLog	setTime(java.util.Date value, java.lang.String... args)

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

store messages for an error

See Also:

Constant Field Values

DBCLASS_GID

public static final GlobalId DBCLASS_GID

store messages for an error

Constructor Detail

DBLog

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

getID

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

setID

@Nonnull
public DBLog setID(int value,
                            java.lang.String... args)
                     throws java.lang.Exception

Throws:

java.lang.Exception

getLevel

@CheckReturnValue
 @Nullable
public DBMessageType getLevel(java.lang.String... args)

findLevel

@CheckReturnValue
 @Nonnull
public final DBMessageType findLevel(java.lang.String... args)
                                                          throws NotFoundException

The level of message, i.e Warning, Stop

--> DBMessageType (String, Searchable)

Parameters:

args - the optional arguments

Returns:

Message Type

Throws:

NotFoundException - DBMessageType was not found

setLevel

@Nonnull
public DBLog setLevel(com.aspc.dal.message.DBMessageType value,
                               java.lang.String... args)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getMessage

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

setMessage

@Nonnull
public DBLog setMessage(java.lang.String value,
                                 java.lang.String... args)
                          throws java.lang.Exception

Throws:

java.lang.Exception

getPerson

@CheckReturnValue
 @Nullable
public Person getPerson(java.lang.String... args)

findPerson

@CheckReturnValue
 @Nonnull
public final Person findPerson(java.lang.String... args)
                                                    throws NotFoundException

User, linked to Person, derived.

--> Person (Integer, Derived, Searchable)

Parameters:

args - the optional arguments

Returns:

Person

Throws:

NotFoundException - Person was not found

getPersonKey

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

setPersonKey

@Nonnull
public DBLog setPersonKey(java.lang.String value,
                                   java.lang.String... args)
                            throws java.lang.Exception

Throws:

java.lang.Exception

getPersonName

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

getSessionId

@Deprecated
 @CheckReturnValue
 @Nonnull
public java.lang.String getSessionId(java.lang.String... args)

Deprecated.

setSessionId

@Deprecated
 @Nonnull
public DBLog setSessionId(java.lang.String value,
                                                java.lang.String... args)
                                         throws java.lang.Exception

Deprecated.

Throws:

java.lang.Exception

getSummaryHTML

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

getTime

@CheckReturnValue
public java.util.Date getTime(java.lang.String... args)

setTime

@Nonnull
public DBLog setTime(java.util.Date value,
                              java.lang.String... args)
                       throws java.lang.Exception

Throws:

java.lang.Exception

create

@Nonnull
 @CheckReturnValue
public static DBLog 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<DBLog> 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 DBLog 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

logError

public static void logError(java.lang.String msg,
                            @Nonnull
                            DataSource ds)

Logs an error with DBFIELD_LEVEL set to ERROR

Parameters:

ds - the datasource

msg - the error message

extGetDerivedValue

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

Gets a derived value for a field that is not a key or linked object

Overrides:

extGetDerivedValue in class DBObject

Parameters:

field - the field value to get

params - the field parameters

Returns:

Object the value, can be null

Throws:

java.lang.Exception - a serious problem

makeHeadLine

@Nonnull
 @CheckReturnValue
protected final java.lang.String makeHeadLine()

makeSummary

@OverridingMethodsMustInvokeSuper
 @Nonnull
 @CheckReturnValue
protected HTMLPanel makeSummary()

extGetDerivedGlobalKey

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

Gets a derived global key for the given field

Overrides:

extGetDerivedGlobalKey in class DBObject

Parameters:

field - the field

params - the field parameters

Returns:

GlobalKey the global key for the field

Throws:

java.lang.Exception - a serious problem