com.microsoft.tfs.core.clients.favorites
Interface IFavoritesStore

All Known Implementing Classes:
IdentityFavoritesStore

public interface IFavoritesStore

Provides a contract for persistence and retrieval of FavoriteItems.

Thread-safety:
unknown

Method Summary
 void connect(TFSTeamProjectCollection tpc, java.lang.String filterNamespace, com.microsoft.tfs.util.GUID identity)
          Provides uniform Connection Mechanism for store instances.
 FavoriteItem[] getFavorites()
          Gets Favorite items associated with connection state.
 com.microsoft.tfs.util.GUID getIdentity()
          Provides the Identity associated with the stored user, which is unique within scope of the TPC.
 boolean isConnected()
          Indicates if the Favorites Store is connected.
 void remove(com.microsoft.tfs.util.GUID[] items)
          Removes specified favorites - Flushes immediately.
 void updateFavorites(FavoriteItem[] items)
          Updates Favorites store with supplied items - Flushes immediately.
 

Method Detail

connect

void connect(TFSTeamProjectCollection tpc,
             java.lang.String filterNamespace,
             com.microsoft.tfs.util.GUID identity)
Provides uniform Connection Mechanism for store instances.


isConnected

boolean isConnected()
Indicates if the Favorites Store is connected.


getFavorites

FavoriteItem[] getFavorites()
Gets Favorite items associated with connection state.


updateFavorites

void updateFavorites(FavoriteItem[] items)
Updates Favorites store with supplied items - Flushes immediately.


remove

void remove(com.microsoft.tfs.util.GUID[] items)
Removes specified favorites - Flushes immediately.


getIdentity

com.microsoft.tfs.util.GUID getIdentity()
Provides the Identity associated with the stored user, which is unique within scope of the TPC. Format is not guaranteed.



© 2015 Microsoft. All rights reserved.