com.wm.app.tn.err
Class ActivityLogEntry

java.lang.Object
  com.wm.app.tn.util.TNFixedData
      com.wm.app.tn.err.ActivityLogEntry

All Implemented Interfaces:

com.wm.data.IData, java.lang.Cloneable

public class ActivityLogEntry
extends TNFixedData

A single entry in the activity log. Creating one of these does not immediately write it to the database; see SystemLog2.dbLog for that. Includes static constants for entry types and the "general" entry class.

See Also:

SystemLog2

Nested Class Summary

Nested classes/interfaces inherited from class com.wm.app.tn.util.TNFixedData

TNFixedData.TreeCursor

Field Summary

static java.lang.String	CLASS_COMMENTS Default entry class for general entries
static java.lang.String	CLASS_CONVADMIN Default entry class for general entries
static java.lang.String	CLASS_CONVLOGIC Default entry class for general entries
static java.lang.String	CLASS_DELIVERY Default entry class for general entries
static java.lang.String	CLASS_DOCTYPEADMINISTRATION Default entry class for general entries
static java.lang.String	CLASS_ENVELOPE Default entry class for general entries
static java.lang.String	CLASS_GENERAL Default entry class for general entries
static java.lang.String	CLASS_PARTNERADMINISTRATION Default entry class for general entries
static java.lang.String	CLASS_POLLING Default entry class for general entries
static java.lang.String	CLASS_PROCESSING Default entry class for general entries
static java.lang.String	CLASS_PROCRULEADMINISTRATION Default entry class for general entries
static java.lang.String	CLASS_PROFEXCHANGE Default entry class for general entries
static java.lang.String	CLASS_RECOGNITION Default entry class for general entries
static java.lang.String	CLASS_ROLEBASEDACCESS Default entry class for general entries
static java.lang.String	CLASS_SAVING Default entry class for general entries
static java.lang.String	CLASS_TPASETTINGS Default entry class for general entries
static java.lang.String	CLASS_VALIDATION Default entry class for general entries
static java.lang.String	CLASS_VERIFICATION Default entry class for general entries
static int	TYPE_ERROR Entry type for errors
static int	TYPE_MESSAGE Entry type for messages
static java.lang.String[]	TYPE_NAMES List of names for entry types -- index by type constant
static int	TYPE_WARNING Entry type for warnings

Constructor Summary

ActivityLogEntry()
For internal use only -- use the four-arg version

ActivityLogEntry(int type, java.lang.String cls, java.lang.String bri, java.lang.String full)
Create an ActivityLogEntry

Method Summary

static com.wm.data.IData	create() For internal use only
static ActivityLogEntry	createError(java.lang.String bri, java.lang.String full) Create an error entry
static ActivityLogEntry	createError(java.lang.String cls, java.lang.String bri, java.lang.String full) Create an error entry
static ActivityLogEntry	createMessage(java.lang.String cls, java.lang.String bri, java.lang.String full) Create a message entry
static ActivityLogEntry	createWarning(java.lang.String cls, java.lang.String bri, java.lang.String full) Create a warning entry
java.lang.String	getB2BUser()
java.lang.String	getBriefMessage()
java.lang.String	getEntryClass()
java.sql.Timestamp	getEntryTimestamp()
int	getEntryType()
java.lang.String	getFullMessage()
java.lang.String	getRelatedConversationId() Deprecated. use getRelatedInstanceId instead
java.lang.String	getRelatedDocId()
java.lang.String	getRelatedDocTypeID()
java.lang.String	getRelatedInstanceId()
java.lang.String	getRelatedPartnerId()
java.lang.String	getRelatedRuleID()
java.lang.String	getRelatedStepId()
void	setB2BUser(java.lang.String s) Set a B2B user related to this entry
void	setBriefMessage(java.lang.String s) Set the brief message on this entry
void	setEntryClass(java.lang.String s) Set the class on this entry
void	setEntryTimestamp(java.sql.Timestamp t) Set the creation time on this entry
void	setEntryType(int t) Set the type on this entry
void	setFullMessage(java.lang.String s) Set the full message on this entry
void	setRelatedConversationId(java.lang.String s) Deprecated. use setRelatedInstanceId instead
void	setRelatedDocId(java.lang.String s) Set the internal ID of a document related to this entry
void	setRelatedDocTypeID(java.lang.String s) Set a DocTypeID related to this entry
void	setRelatedInstanceId(java.lang.String s) Set the ID of a process related to this entry
void	setRelatedPartnerId(java.lang.String s) Set the internal ID of a partner related to this entry
void	setRelatedRuleID(java.lang.String s) Set a Processing Rule ID related to this entry
void	setRelatedStepId(java.lang.String s) Set the ID of a process step related to this entry

Methods inherited from class com.wm.app.tn.util.TNFixedData

clone, dataSize, get, get, getCursor, getHashCursor, getIndexCursor, getKey, getSharedCursor, getTreeCursor, indexOf, merge, set, set, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_ERROR

public static final int TYPE_ERROR

Entry type for errors

See Also:

Constant Field Values

TYPE_WARNING

public static final int TYPE_WARNING

Entry type for warnings

See Also:

Constant Field Values

TYPE_MESSAGE

public static final int TYPE_MESSAGE

Entry type for messages

See Also:

Constant Field Values

TYPE_NAMES

public static final java.lang.String[] TYPE_NAMES

List of names for entry types -- index by type constant

CLASS_GENERAL

public static final java.lang.String CLASS_GENERAL

Default entry class for general entries

See Also:

Constant Field Values

CLASS_CONVADMIN

public static final java.lang.String CLASS_CONVADMIN

Default entry class for general entries

See Also:

Constant Field Values

CLASS_CONVLOGIC

public static final java.lang.String CLASS_CONVLOGIC

Default entry class for general entries

See Also:

Constant Field Values

CLASS_DELIVERY

public static final java.lang.String CLASS_DELIVERY

Default entry class for general entries

See Also:

Constant Field Values

CLASS_ENVELOPE

public static final java.lang.String CLASS_ENVELOPE

Default entry class for general entries

See Also:

Constant Field Values

CLASS_SAVING

public static final java.lang.String CLASS_SAVING

Default entry class for general entries

See Also:

Constant Field Values

CLASS_RECOGNITION

public static final java.lang.String CLASS_RECOGNITION

Default entry class for general entries

See Also:

Constant Field Values

CLASS_PROCESSING

public static final java.lang.String CLASS_PROCESSING

Default entry class for general entries

See Also:

Constant Field Values

CLASS_VALIDATION

public static final java.lang.String CLASS_VALIDATION

Default entry class for general entries

See Also:

Constant Field Values

CLASS_VERIFICATION

public static final java.lang.String CLASS_VERIFICATION

Default entry class for general entries

See Also:

Constant Field Values

CLASS_PROFEXCHANGE

public static final java.lang.String CLASS_PROFEXCHANGE

Default entry class for general entries

See Also:

Constant Field Values

CLASS_ROLEBASEDACCESS

public static final java.lang.String CLASS_ROLEBASEDACCESS

Default entry class for general entries

See Also:

Constant Field Values

CLASS_PARTNERADMINISTRATION

public static final java.lang.String CLASS_PARTNERADMINISTRATION

Default entry class for general entries

See Also:

Constant Field Values

CLASS_COMMENTS

public static final java.lang.String CLASS_COMMENTS

Default entry class for general entries

See Also:

Constant Field Values

CLASS_POLLING

public static final java.lang.String CLASS_POLLING

Default entry class for general entries

See Also:

Constant Field Values

CLASS_TPASETTINGS

public static final java.lang.String CLASS_TPASETTINGS

Default entry class for general entries

See Also:

Constant Field Values

CLASS_DOCTYPEADMINISTRATION

public static final java.lang.String CLASS_DOCTYPEADMINISTRATION

Default entry class for general entries

See Also:

Constant Field Values

CLASS_PROCRULEADMINISTRATION

public static final java.lang.String CLASS_PROCRULEADMINISTRATION

Default entry class for general entries

See Also:

Constant Field Values

Constructor Detail

ActivityLogEntry

public ActivityLogEntry()

For internal use only -- use the four-arg version

ActivityLogEntry

public ActivityLogEntry(int type,
                        java.lang.String cls,
                        java.lang.String bri,
                        java.lang.String full)

Create an ActivityLogEntry

Parameters:

type - the entry type (should be one of TYPE_ERROR, TYPE_WARNING, or TYPE_MESSAGE)

cls - the entry class

bri - the brief message

full - the full message (may be null)

Method Detail

createError

public static ActivityLogEntry createError(java.lang.String bri,
                                           java.lang.String full)

Create an error entry

Parameters:

bri - the brief message

full - the full message

Returns:

a new "general" error entry with the supplied brief and full messages

createError

public static ActivityLogEntry createError(java.lang.String cls,
                                           java.lang.String bri,
                                           java.lang.String full)

Create an error entry

Parameters:

cls - the entry class

bri - the brief message

full - the full message

Returns:

a new error entry with the supplied class, brief and full messages

createWarning

public static ActivityLogEntry createWarning(java.lang.String cls,
                                             java.lang.String bri,
                                             java.lang.String full)

Create a warning entry

Parameters:

cls - the entry class

bri - the brief message

full - the full message

Returns:

a new warning entry with the supplied class, brief and full messages

createMessage

public static ActivityLogEntry createMessage(java.lang.String cls,
                                             java.lang.String bri,
                                             java.lang.String full)

Create a message entry

Parameters:

cls - the entry class

bri - the brief message

full - the full message

Returns:

a new message entry with the supplied class, brief and full messages

create

public static com.wm.data.IData create()

For internal use only

getEntryTimestamp

public java.sql.Timestamp getEntryTimestamp()

Returns:

the time this entry was created

getEntryType

public int getEntryType()

Returns:

the type of this entry

getEntryClass

public java.lang.String getEntryClass()

Returns:

the class of this entry

getBriefMessage

public java.lang.String getBriefMessage()

Returns:

the brief message of this entry

getFullMessage

public java.lang.String getFullMessage()

Returns:

the full message of this entry

getRelatedDocId

public java.lang.String getRelatedDocId()

Returns:

internal ID of document related to this entry

getRelatedPartnerId

public java.lang.String getRelatedPartnerId()

Returns:

internal ID of partner related to this entry

getRelatedConversationId

public java.lang.String getRelatedConversationId()

Deprecated. use getRelatedInstanceId instead

getRelatedInstanceId

public java.lang.String getRelatedInstanceId()

Returns:

ID of process related to this entry

getRelatedStepId

public java.lang.String getRelatedStepId()

Returns:

ID of process step related to this entry

getB2BUser

public java.lang.String getB2BUser()

Returns:

the B2B user related to this entry

getRelatedDocTypeID

public java.lang.String getRelatedDocTypeID()

Returns:

the DocTypeID related to this entry

getRelatedRuleID

public java.lang.String getRelatedRuleID()

Returns:

the Processing Rule ID related to this entry

setEntryTimestamp

public void setEntryTimestamp(java.sql.Timestamp t)

Set the creation time on this entry

setEntryType

public void setEntryType(int t)

Set the type on this entry

setEntryClass

public void setEntryClass(java.lang.String s)

Set the class on this entry

setBriefMessage

public void setBriefMessage(java.lang.String s)

Set the brief message on this entry

setFullMessage

public void setFullMessage(java.lang.String s)

Set the full message on this entry

setRelatedDocId

public void setRelatedDocId(java.lang.String s)

Set the internal ID of a document related to this entry

setRelatedPartnerId

public void setRelatedPartnerId(java.lang.String s)

Set the internal ID of a partner related to this entry

setRelatedConversationId

public void setRelatedConversationId(java.lang.String s)

Deprecated. use setRelatedInstanceId instead

setRelatedInstanceId

public void setRelatedInstanceId(java.lang.String s)

Set the ID of a process related to this entry

setRelatedStepId

public void setRelatedStepId(java.lang.String s)

Set the ID of a process step related to this entry

setB2BUser

public void setB2BUser(java.lang.String s)

Set a B2B user related to this entry

setRelatedDocTypeID

public void setRelatedDocTypeID(java.lang.String s)

Set a DocTypeID related to this entry

setRelatedRuleID

public void setRelatedRuleID(java.lang.String s)

Set a Processing Rule ID related to this entry