com.microsoft.tfs.core.clients.favorites
Class IdentityFavoritesStore

java.lang.Object
  extended by com.microsoft.tfs.core.clients.favorites.IdentityFavoritesStore
All Implemented Interfaces:
IFavoritesStore

public class IdentityFavoritesStore
extends java.lang.Object
implements IFavoritesStore

Identity Store based implementation of IFavoritesStore

Thread-safety:
thread-compatible

Constructor Summary
IdentityFavoritesStore()
           
 
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.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IdentityFavoritesStore

public IdentityFavoritesStore()
Method Detail

connect

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

Initializes store, if the supplied Team Project Collection supports Identity Management Service 2, which is currently required for using Identity based Favorites.

Specified by:
connect in interface IFavoritesStore

isConnected

public boolean isConnected()
Description copied from interface: IFavoritesStore
Indicates if the Favorites Store is connected.

Specified by:
isConnected in interface IFavoritesStore

getFavorites

public FavoriteItem[] getFavorites()
Description copied from interface: IFavoritesStore
Gets Favorite items associated with connection state.

Specified by:
getFavorites in interface IFavoritesStore

updateFavorites

public void updateFavorites(FavoriteItem[] items)
Description copied from interface: IFavoritesStore
Updates Favorites store with supplied items - Flushes immediately.

Specified by:
updateFavorites in interface IFavoritesStore

remove

public void remove(com.microsoft.tfs.util.GUID[] items)
Description copied from interface: IFavoritesStore
Removes specified favorites - Flushes immediately.

Specified by:
remove in interface IFavoritesStore

getIdentity

public com.microsoft.tfs.util.GUID getIdentity()
Description copied from interface: IFavoritesStore
Provides the Identity associated with the stored user, which is unique within scope of the TPC. Format is not guaranteed.

Specified by:
getIdentity in interface IFavoritesStore


© 2015 Microsoft. All rights reserved.