com.isti.util
Class IstiMessageCachedArchive.BasicArchivableMsgObjEntry

java.lang.Object
  extended by com.isti.util.IstiTimeObjectCache.BasicTimeObjectEntry
      extended by com.isti.util.IstiMessageObjectCache.BasicMessageObjectEntry
          extended by com.isti.util.IstiMessageCachedArchive.BasicArchivableMsgObjEntry
All Implemented Interfaces:
Archivable, IstiMessageCachedArchive.ArchivableMsgObjEntry, IstiMessageObjectCache.MessageObjectEntry, IstiTimeObjectCache.TimeObjectEntry
Direct Known Subclasses:
MsgCachedArchiveTest.QWServerMsgRecord
Enclosing class:
IstiMessageCachedArchive

public abstract static class IstiMessageCachedArchive.BasicArchivableMsgObjEntry
extends IstiMessageObjectCache.BasicMessageObjectEntry
implements IstiMessageCachedArchive.ArchivableMsgObjEntry

Abstract class BasicArchivableMsgObjEntry is an extension of the message- object-entry class that also implements the 'Archivable' interface. This class should be extended to include an Archivable-interface- compatible constructor and a 'toArchivedForm()' method. The 'equals()' method should also be implemented.


Nested Class Summary
 
Nested classes/interfaces inherited from interface com.isti.util.Archivable
Archivable.Marker
 
Field Summary
 
Fields inherited from class com.isti.util.IstiMessageObjectCache.BasicMessageObjectEntry
msgNum
 
Fields inherited from class com.isti.util.IstiTimeObjectCache.BasicTimeObjectEntry
dataObj, dataSize, keyStr, timeGenerated
 
Constructor Summary
protected IstiMessageCachedArchive.BasicArchivableMsgObjEntry()
          No-argument constructor for subclasses.
  IstiMessageCachedArchive.BasicArchivableMsgObjEntry(long timeGenerated, java.lang.Object msgObj, java.lang.String msgStr, long msgNum)
          Creates a message object entry.
 
Method Summary
 java.util.Date getArchiveDate()
          Returns a 'Date' object representing the date to be used for archival purposes.
 
Methods inherited from class com.isti.util.IstiMessageObjectCache.BasicMessageObjectEntry
getMsgNum
 
Methods inherited from class com.isti.util.IstiTimeObjectCache.BasicTimeObjectEntry
getDataObj, getDataSize, getKeyStr, getTimeGenerated, setDataSize
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.isti.util.IstiMessageObjectCache.MessageObjectEntry
getMsgNum
 
Methods inherited from interface com.isti.util.IstiTimeObjectCache.TimeObjectEntry
getDataObj, getDataSize, getKeyStr, getTimeGenerated
 
Methods inherited from interface com.isti.util.Archivable
toArchivedForm
 

Constructor Detail

IstiMessageCachedArchive.BasicArchivableMsgObjEntry

public IstiMessageCachedArchive.BasicArchivableMsgObjEntry(long timeGenerated,
                                                           java.lang.Object msgObj,
                                                           java.lang.String msgStr,
                                                           long msgNum)
Creates a message object entry.

Parameters:
timeGenerated - the time the message was generated.
msgObj - message object.
msgStr - message string (used as a key into the cache-table).
msgNum - message number.

IstiMessageCachedArchive.BasicArchivableMsgObjEntry

protected IstiMessageCachedArchive.BasicArchivableMsgObjEntry()
No-argument constructor for subclasses.

Method Detail

getArchiveDate

public java.util.Date getArchiveDate()
Returns a 'Date' object representing the date to be used for archival purposes.

Specified by:
getArchiveDate in interface Archivable
Returns:
A 'Date' object representing the date that the item should be archived under.