org.grouplens.lenskit.data.event

Interface Event

All Known Subinterfaces:

Like, LikeBatch, Rating

All Known Implementing Classes:

MutableRating

public interface Event

An event in a user's history. Events are associated with items. In some cases, it makes sense that a user may have events not associated with an item (such as login/logout events). We recommend that integrators use a designated item ID in such cases. If that item type never shows up in events used by recommenders, then it should not affect the recommenders.

Events are immutable. Deviations must be clearly documented and only used in very limited cases (e.g. to implement fast iterators).

Compatibility

Public

Method Summary

Modifier and Type	Method and Description
long	getItemId() Get the item ID.
long	getTimestamp() Get the event timestamp.
long	getUserId() Get the ID of the user responsible for the event.

Method Detail

getUserId

long getUserId()

Get the ID of the user responsible for the event.

Returns:

The event's user ID.

getItemId

long getItemId()

Get the item ID.

Returns:

The item ID of the event.

getTimestamp

long getTimestamp()

Get the event timestamp. A timestamp of -1 indicates that the event has no timestamp; such events should generally be considered to happen infinitely long ago.

Returns:

The event timestamp, or -1 if there is no timestamp.