net.sourceforge.esw.service.log
Interface ILogDatum

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

DefaultLogDatum, LogDatumNodeAdapter, CleanLogDatum

public interface ILogDatum

extends java.io.Serializable

Describes an instance of logged data, used by an ILog instance to log data.

Using this interface is the perferred way to log data into an ILog instance. The allows the ILog instance to know exactly where to get all the info it needs to log data.

See Also:

ILog

Method Summary

java.lang.String	getApplicationID() Returns the identifier for the type of data being logged via this ILogDatum instance.
INode	getData() Returns the INote instance that represents the data to be logged via this ILogDatum instance.
long	getDatumID() Returns a unique id for this LogDatum Instance.
java.lang.String	getDescription() Returns the String description of this ILogDatum instance.
int	getRank() Returns the rank of this ILogDatum instance's data to be used to consider priority amongst more than one ILogDatum instance.
java.util.Date	getWhen() Returns when this ILogDatum instance's data was considered to have occured at for logging purposes.
java.lang.String	getWhere() Returns where this ILogDatum instance's data was considered to have occured for logging purposes.

Method Detail

getWhen

public java.util.Date getWhen()

Returns when this ILogDatum instance's data was considered to have occured at for logging purposes. This is the when of the logged data.

Returns:

when the datum occured

getWhere

public java.lang.String getWhere()

Returns where this ILogDatum instance's data was considered to have occured for logging purposes. This is the where of the logged data.

Returns:

where the datum occured

getRank

public int getRank()

Returns the rank of this ILogDatum instance's data to be used to consider priority amongst more than one ILogDatum instance. This is the importance of the logged data.

Returns:

the priority of this datum

getDescription

public java.lang.String getDescription()

Returns the String description of this ILogDatum instance. This is the simple what of the logged data.

Returns:

the String description of this ILogDatum instance.

getData

public INode getData()

Returns the INote instance that represents the data to be logged via this ILogDatum instance. This is the complex what of the logged data.

Returns:

the data of this ILogDataum instance.

getApplicationID

public java.lang.String getApplicationID()

Returns the identifier for the type of data being logged via this ILogDatum instance. This is the who of the logged data.

Returns:

the ID of the Application logging the data.

getDatumID

public long getDatumID()

Returns a unique id for this LogDatum Instance. Unique across all VMs

Returns:

the id of this datum