com.atlassian.jira.favourites
Class OfBizFavouritesStore

java.lang.Object
  extended by com.atlassian.jira.favourites.OfBizFavouritesStore
All Implemented Interfaces:
FavouritesStore

public class OfBizFavouritesStore
extends java.lang.Object
implements FavouritesStore

FavouritesStore that uses the OfBiz to store favourites

Since:
v3.13

Constructor Summary
OfBizFavouritesStore(OfBizDelegator delegator)
           
 
Method Summary
 boolean addFavourite(com.opensymphony.user.User user, SharedEntity entity)
          Create Favourites association between User and entity
 java.util.Collection<java.lang.Long> getFavouriteIds(com.opensymphony.user.User user, SharedEntity.TypeDescriptor<?> entityType)
          Get the ids of a user's favourite Entities for a given entity type
 boolean isFavourite(com.opensymphony.user.User user, SharedEntity entity)
          Checks to see if entity is a favourite of the user passed in.
 boolean removeFavourite(com.opensymphony.user.User user, SharedEntity entity)
          Remove Favourites association between User and entity
 void removeFavouritesForEntity(SharedEntity entity)
          Remove all favourite associations for a given entity.
 void removeFavouritesForUser(com.opensymphony.user.User user, SharedEntity.TypeDescriptor<?> entityType)
          Remove the favourite associations for the given User and the given type
 void updateSequence(com.opensymphony.user.User user, java.util.List<? extends SharedEntity> favouriteEntities)
          Called to update the sequence of a list of favourite shared entities
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OfBizFavouritesStore

public OfBizFavouritesStore(OfBizDelegator delegator)
Method Detail

addFavourite

public boolean addFavourite(com.opensymphony.user.User user,
                            SharedEntity entity)
Description copied from interface: FavouritesStore
Create Favourites association between User and entity

Specified by:
addFavourite in interface FavouritesStore
Parameters:
user - to associate entity with
entity - the entity to associate with
Returns:
true if association was successfully made, else false if it wasn't made or already existed.

removeFavourite

public boolean removeFavourite(com.opensymphony.user.User user,
                               SharedEntity entity)
Description copied from interface: FavouritesStore
Remove Favourites association between User and entity

Specified by:
removeFavourite in interface FavouritesStore
Parameters:
user - to disassociate entity with
entity - the entity to disassociate with
Returns:
true if association was successfully removed, else false

isFavourite

public boolean isFavourite(com.opensymphony.user.User user,
                           SharedEntity entity)
Description copied from interface: FavouritesStore
Checks to see if entity is a favourite of the user passed in.

Specified by:
isFavourite in interface FavouritesStore
Parameters:
user - to check entity with
entity - the entity to check with
Returns:
true if user has favourite association with entity

getFavouriteIds

public java.util.Collection<java.lang.Long> getFavouriteIds(com.opensymphony.user.User user,
                                                            SharedEntity.TypeDescriptor<?> entityType)
Description copied from interface: FavouritesStore
Get the ids of a user's favourite Entities for a given entity type

Specified by:
getFavouriteIds in interface FavouritesStore
Parameters:
user - The user for the associated entities
entityType - The type of entities to get. E.g. SearchRequest.ENTITY_TYPE
Returns:
A Collection on Longs that represent the entities

removeFavouritesForUser

public void removeFavouritesForUser(com.opensymphony.user.User user,
                                    SharedEntity.TypeDescriptor<?> entityType)
Description copied from interface: FavouritesStore
Remove the favourite associations for the given User and the given type

Specified by:
removeFavouritesForUser in interface FavouritesStore
Parameters:
user - The user with whom to disassociate entities with
entityType - The type of entity to disassociate user with.

removeFavouritesForEntity

public void removeFavouritesForEntity(SharedEntity entity)
Description copied from interface: FavouritesStore
Remove all favourite associations for a given entity.

Specified by:
removeFavouritesForEntity in interface FavouritesStore
Parameters:
entity - The entity to remove all associations with

updateSequence

public void updateSequence(com.opensymphony.user.User user,
                           java.util.List<? extends SharedEntity> favouriteEntities)
Description copied from interface: FavouritesStore
Called to update the sequence of a list of favourite shared entities

Specified by:
updateSequence in interface FavouritesStore
Parameters:
user - the user in play
favouriteEntities - the list specifying the order of the SharedEntitys


Copyright © 2002-2010 Atlassian. All Rights Reserved.