com.isti.util

Interface Archivable

All Known Subinterfaces:

IstiMessageCachedArchive.ArchivableMsgObjEntry

All Known Implementing Classes:

ArchivableData, IstiLocale, IstiMessageCachedArchive.BasicArchivableMsgObjEntry, ValueTimeBlock

public interface Archivable

An interface for objects that can be archived. Archivable classes must have a constructor with 'String' and 'Archivable.Marker' parameters, like this:
public ArchivableImpl(String dataStr, Archivable.Marker mkrObj) ...
This constructor is used to create the class from a string of data. The 'Archivable.Marker' is used to mark the constructor as being available for de-archiving (and will usually be 'null').

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Archivable.Marker

Method Summary

Modifier and Type	Method and Description
java.util.Date	getArchiveDate() Returns a 'Date' object representing the date to be used for archival purposes.
java.lang.String	toArchivedForm() Returns the archivable representation for this object.

Method Detail

getArchiveDate

java.util.Date getArchiveDate()

Returns a 'Date' object representing the date to be used for archival purposes.

Returns:

A 'Date' object representing the date that the item should be archived under.

toArchivedForm

java.lang.String toArchivedForm()

Returns the archivable representation for this object. When the object is recreated from the string, it should be identical to the original.

Returns:

A String representing the archived form of the object.