org.starhope.appius.user.notifications
Class NotificationSet

java.lang.Object
  org.starhope.appius.util.SimpleDataRecord<SimpleDataRecordSet<DataRecordClass,DataRecordSetClass>>
      org.starhope.appius.util.SimpleDataRecordSet<Notification,NotificationSet>
          org.starhope.appius.user.notifications.NotificationSet

All Implemented Interfaces:

com.whirlycott.cache.Cacheable, Serializable, Comparable<SimpleDataRecordSet<Notification,NotificationSet>>, Iterable<Notification>, Collection<Notification>, CTime, DataRecord, DataRecordSet<Notification>, HasSubversionRevision

public class NotificationSet
extends SimpleDataRecordSet<Notification,NotificationSet>

The collection of all (potentially active) Notifications associated with a given user.

Author:

twheys@gmail.com, brpocock@star-hope.org

See Also:

Serialized Form

Field Summary

private int	myUserID The user whose set of notifications this represents.
private static long	serialVersionUID WRITEME: Document this brpocock@star-hope.org

Fields inherited from class org.starhope.appius.util.SimpleDataRecord

myLoader, timeLastChanged, timeLastSaved

Constructor Summary

NotificationSet(int userID)

NotificationSet(UserRecord who)

Method Summary

int	getCacheableID() Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.
String	getCacheableIdent() Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.
String	getSubversionRevision() Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.

Methods inherited from class org.starhope.appius.util.SimpleDataRecordSet

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

Methods inherited from class org.starhope.appius.util.SimpleDataRecord

changed, checkStale, compareTo, equals, finalize, getRecordLoader, getTimeLastChanged, getTimeLastSaved, hashCode, isBeingLoaded, markAsLoaded, markAsSaved, markForReload, onRemove, onRetrieve, onStore, save, setRecordLoader, toString

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Collection

equals, hashCode

Methods inherited from interface org.starhope.appius.util.DataRecord

checkStale, getRecordLoader, isBeingLoaded, markAsLoaded, markAsSaved, setRecordLoader

Methods inherited from interface org.starhope.appius.util.CTime

getTimeLastChanged, getTimeLastSaved

Methods inherited from interface com.whirlycott.cache.Cacheable

onRemove, onRetrieve, onStore

Field Detail

serialVersionUID

private static final long serialVersionUID

WRITEME: Document this brpocock@star-hope.org

See Also:

Constant Field Values

myUserID

private final int myUserID

The user whose set of notifications this represents.

Constructor Detail

NotificationSet

public NotificationSet(int userID)

Parameters:

userID - the user ID of the user for whom this is the notification set

NotificationSet

public NotificationSet(UserRecord who)

Parameters:

who - the user record of the user for whom this is the notification set

Method Detail

getCacheableID

public int getCacheableID()

Description copied from interface: DataRecord

Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.

Returns:

an unique ID number

See Also:

DataRecord.getCacheableID()

getCacheableIdent

public String getCacheableIdent()

Description copied from interface: DataRecord

Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.

Returns:

an unique identifier string

See Also:

DataRecord.getCacheableIdent()

getSubversionRevision

public String getSubversionRevision()

Description copied from interface: HasSubversionRevision

Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.

As an example,the Subversion revision string for this file is "$Rev: 1968 $"

 
 @Override
 public String getSubversionRevision () {
        return "$Rev: ";
 }
 

Returns:

The Subversion revision level for this class's source code file.

See Also:

HasSubversionRevision.getSubversionRevision()