com.ptc.windchill.cadx.common.htmllog
Class HTMLLogMessage

java.lang.Object
  com.ptc.windchill.cadx.common.htmllog.HTMLLogMessage

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Persistable, Serializable

public class HTMLLogMessage

extends Object

implements Persistable, Externalizable

Use the newHTMLLogMessage static factory method(s), not the HTMLLogMessage constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	CREATE_DATE Label for the attribute.
static String	CREATE_TIME Label for the attribute.
private Timestamp	createDate
private long	createTime
static int	DEBUG_MSG Supported API: false
static int	ERROR_MSG Supported API: false
static long	EXTERNALIZATION_VERSION_UID
static int	INFO_MSG Supported API: false
static String	LOG Label for the attribute.
static String	LOG_REFERENCE Label for the attribute.
private ObjectReference	logReference
private String	message
static String	MESSAGE Label for the attribute.
static String	MESSAGE_TYPE Label for the attribute.
private static int	MESSAGE_UPPER_LIMIT
private int	messageType
protected static long	OLD_FORMAT_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
static int	STATUS_MSG Supported API: false
private PersistInfo	thePersistInfo
static int	WARNING_MSG Supported API: false

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Constructor Summary

HTMLLogMessage()

Method Summary

void	checkAttributes() Validate the values of this Persistable object's attributes.
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
Timestamp	getCreateDate() Gets the value of the attribute: CREATE_DATE.
long	getCreateTime() Gets the value of the attribute: CREATE_TIME.
String	getIdentity() Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().
HTMLLog	getLog() Gets the object for the association that plays role: LOG.
ObjectReference	getLogReference() Gets the value of the attribute: LOG_REFERENCE.
String	getMessage() Gets the value of the attribute: MESSAGE.
int	getMessageType() Gets the value of the attribute: MESSAGE_TYPE.
PersistInfo	getPersistInfo() Gets the object for the association that plays role: PERSIST_INFO.
String	getType() Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
protected void	initialize() Supports initialization, following construction of an instance.
void	initialize(int msgType, String msg, Timestamp timeStamp, long time) Supported API: false
boolean	isDebugMessage() Supported API: false
boolean	isErrorMessage() Supported API: false
boolean	isInfoMessage() Supported API: false
boolean	isStatusMessage() Supported API: false
boolean	isWarningMessage() Supported API: false
private void	logReferenceValidate(ObjectReference a_LogReference)
private void	messageValidate(String a_Message)
static HTMLLogMessage	newHTMLLogMessage() Default factory for the class.
static HTMLLogMessage	newHTMLLogMessage(int msgType, String msg, Timestamp timeStamp, long time) Supported API: false
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(HTMLLogMessage thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setCreateDate(Timestamp a_CreateDate) Sets the value of the attribute: CREATE_DATE.
void	setCreateTime(long a_CreateTime) Sets the value of the attribute: CREATE_TIME.
void	setLog(HTMLLog a_Log) Sets the object for the association that plays role: LOG.
void	setLogReference(ObjectReference a_LogReference) Sets the value of the attribute: LOG_REFERENCE.
void	setMessage(String a_Message) Sets the value of the attribute: MESSAGE.
void	setMessageType(int a_MessageType) Sets the value of the attribute: MESSAGE_TYPE.
void	setPersistInfo(PersistInfo a_PersistInfo) Sets the object for the association that plays role: PERSIST_INFO.
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

DEBUG_MSG

public static final int DEBUG_MSG

Supported API: false

See Also:

Constant Field Values

STATUS_MSG

public static final int STATUS_MSG

Supported API: false

See Also:

Constant Field Values

INFO_MSG

public static final int INFO_MSG

Supported API: false

See Also:

Constant Field Values

WARNING_MSG

public static final int WARNING_MSG

Supported API: false

See Also:

Constant Field Values

ERROR_MSG

public static final int ERROR_MSG

Supported API: false

See Also:

Constant Field Values

MESSAGE_TYPE

public static final String MESSAGE_TYPE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

messageType

private int messageType

MESSAGE

public static final String MESSAGE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

MESSAGE_UPPER_LIMIT

private static int MESSAGE_UPPER_LIMIT

message

private String message

CREATE_DATE

public static final String CREATE_DATE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

createDate

private Timestamp createDate

CREATE_TIME

public static final String CREATE_TIME

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

createTime

private long createTime

LOG

public static final String LOG

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

LOG_REFERENCE

public static final String LOG_REFERENCE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

logReference

private ObjectReference logReference

thePersistInfo

private PersistInfo thePersistInfo

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

HTMLLogMessage

public HTMLLogMessage()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(HTMLLogMessage thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getMessageType

public int getMessageType()

Gets the value of the attribute: MESSAGE_TYPE.

Supported API: false

Returns:

int

setMessageType

public void setMessageType(int a_MessageType)
                    throws WTPropertyVetoException

Sets the value of the attribute: MESSAGE_TYPE.

Supported API: false

Parameters:

a_MessageType -

Throws:

WTPropertyVetoException

getMessage

public String getMessage()

Gets the value of the attribute: MESSAGE.

Supported API: false

Returns:

String

setMessage

public void setMessage(String a_Message)
                throws WTPropertyVetoException

Sets the value of the attribute: MESSAGE.

Supported API: false

Parameters:

a_Message -

Throws:

WTPropertyVetoException

messageValidate

private void messageValidate(String a_Message)
                      throws WTPropertyVetoException

Parameters:

a_Message -

Throws:

WTPropertyVetoException

getCreateDate

public Timestamp getCreateDate()

Gets the value of the attribute: CREATE_DATE.

Supported API: false

Returns:

Timestamp

setCreateDate

public void setCreateDate(Timestamp a_CreateDate)
                   throws WTPropertyVetoException

Sets the value of the attribute: CREATE_DATE.

Supported API: false

Parameters:

a_CreateDate -

Throws:

WTPropertyVetoException

getCreateTime

public long getCreateTime()

Gets the value of the attribute: CREATE_TIME.

Supported API: false

Returns:

long

setCreateTime

public void setCreateTime(long a_CreateTime)
                   throws WTPropertyVetoException

Sets the value of the attribute: CREATE_TIME.

Supported API: false

Parameters:

a_CreateTime -

Throws:

WTPropertyVetoException

getLog

public HTMLLog getLog()

Gets the object for the association that plays role: LOG.

Supported API: false

Returns:

HTMLLog

setLog

public void setLog(HTMLLog a_Log)
            throws WTPropertyVetoException,
                   WTException

Sets the object for the association that plays role: LOG.

Supported API: false

Parameters:

a_Log -

Throws:

WTPropertyVetoException

WTException

getLogReference

public ObjectReference getLogReference()

Gets the value of the attribute: LOG_REFERENCE.

Supported API: false

Returns:

ObjectReference

setLogReference

public void setLogReference(ObjectReference a_LogReference)
                     throws WTPropertyVetoException

Sets the value of the attribute: LOG_REFERENCE.

Supported API: false

Parameters:

a_LogReference -

Throws:

WTPropertyVetoException

logReferenceValidate

private void logReferenceValidate(ObjectReference a_LogReference)
                           throws WTPropertyVetoException

Parameters:

a_LogReference -

Throws:

WTPropertyVetoException

isDebugMessage

public boolean isDebugMessage()

Supported API: false

Returns:

boolean

isStatusMessage

public boolean isStatusMessage()

Supported API: false

Returns:

boolean

isInfoMessage

public boolean isInfoMessage()

Supported API: false

Returns:

boolean

isWarningMessage

public boolean isWarningMessage()

Supported API: false

Returns:

boolean

isErrorMessage

public boolean isErrorMessage()

Supported API: false

Returns:

boolean

newHTMLLogMessage

public static HTMLLogMessage newHTMLLogMessage(int msgType,
                                               String msg,
                                               Timestamp timeStamp,
                                               long time)

Supported API: false

Parameters:

msgType -

msg -

timeStamp -

time -

Returns:

HTMLLogMessage

initialize

public void initialize(int msgType,
                       String msg,
                       Timestamp timeStamp,
                       long time)

Supported API: false

Parameters:

msgType -

msg -

timeStamp -

time -

newHTMLLogMessage

public static HTMLLogMessage newHTMLLogMessage()
                                        throws WTException

Default factory for the class.

Supported API: false

Returns:

HTMLLogMessage

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Throws:

WTException

getIdentity

public String getIdentity()

Deprecated. Replaced by IdentityFactory.getDispayIdentifier(object) to return a localizable equivalent of getIdentity(). To return a localizable value which includes the object type, use IdentityFactory.getDisplayIdentity(object). Other alternatives are ((WTObject)obj).getDisplayIdentifier() and ((WTObject)obj).getDisplayIdentity().

Gets the value of the attribute: IDENTITY. Supplies the identity of the object for business purposes. The identity is composed of name, number or possibly other attributes. The identity does not include the type of the object.

Supported API: false

Specified by:

getIdentity in interface Persistable

Returns:

String

getType

public String getType()

Deprecated. Replaced by IdentityFactory.getDispayType(object) to return a localizable equivalent of getType(). Another alternative is ((WTObject)obj).getDisplayType().

Gets the value of the attribute: TYPE. Identifies the type of the object for business purposes. This is typically the class name of the object but may be derived from some other attribute of the object.

Supported API: false

Specified by:

getType in interface Persistable

Returns:

String

checkAttributes

public void checkAttributes()
                     throws InvalidAttributeException

Validate the values of this Persistable object's attributes.

Supported API: false

Specified by:

checkAttributes in interface Persistable

Throws:

InvalidAttributeException

getPersistInfo

public PersistInfo getPersistInfo()

Gets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

getPersistInfo in interface Persistable

Returns:

PersistInfo

setPersistInfo

public void setPersistInfo(PersistInfo a_PersistInfo)

Sets the object for the association that plays role: PERSIST_INFO.

Supported API: false

Specified by:

setPersistInfo in interface Persistable

Parameters:

a_PersistInfo -

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Returns:

int