org.eclipse.ecf.presence.roster
Interface IRoster

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IRosterItem

All Known Implementing Classes:

Roster

public interface IRoster
extends IRosterItem

Roster (aka contacts list or buddy list)

Method Summary

java.util.Collection	getItems() Get the IRosterItems for this roster.
IPresenceContainerAdapter	getPresenceContainerAdapter() Get the IPresenceContainerAdapter associated with this roster.
IUser	getUser() Get local user for this roster.

Methods inherited from interface org.eclipse.ecf.presence.roster.IRosterItem

getName, getParent, getRoster

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Method Detail

getUser

IUser getUser()

Get local user for this roster. This is the user that owns this roster. If null, this means that the user is not yet logged in.

Returns:

IUser local user associated with this roster. If null, this means that the user is not yet logged in.

getItems

java.util.Collection getItems()

Get the IRosterItems for this roster. The collection returned will not be null, and will contain IRosterItems. The IRosterItems may be either IRosterGroups and/or IRosterEntries.

Returns:

Collection of IRosterItems. Will not be null. May return an empty collection of items.

getPresenceContainerAdapter

IPresenceContainerAdapter getPresenceContainerAdapter()

Get the IPresenceContainerAdapter associated with this roster. The result will not be null.

Returns:

IPresenceContainerAdapter the presence container adapter associated with this roster.