public interface FavouritesStore
Modifier and Type | Method and Description |
---|---|
boolean |
addFavourite(ApplicationUser user,
SharedEntity entity)
Create Favourites association between User and entity
|
Collection<Long> |
getFavouriteIds(ApplicationUser user,
SharedEntity.TypeDescriptor<?> entityType)
Get the ids of a user's favourite Entities for a given entity type
|
Collection<Long> |
getFavouriteIds(String userKey,
SharedEntity.TypeDescriptor<?> entityType)
Get the ids of a user's favourite Entities for a given entity type
|
boolean |
isFavourite(ApplicationUser user,
SharedEntity entity)
Checks to see if entity is a favourite of the user passed in.
|
boolean |
removeFavourite(ApplicationUser user,
SharedEntity entity)
Remove Favourites association between User and entity
|
void |
removeFavouritesForEntity(SharedEntity entity)
Remove all favourite associations for a given entity.
|
void |
removeFavouritesForUser(ApplicationUser user,
SharedEntity.TypeDescriptor<?> entityType)
Remove the favourite associations for the given User and the given type
|
void |
updateSequence(ApplicationUser user,
List<? extends SharedEntity> favouriteEntities)
Called to update the sequence of a list of favourite
shared entities |
boolean addFavourite(ApplicationUser user, SharedEntity entity)
user
- User to associate entity withentity
- the entity to associate withboolean removeFavourite(ApplicationUser user, SharedEntity entity)
user
- to disassociate entity withentity
- the entity to disassociate withboolean isFavourite(ApplicationUser user, SharedEntity entity)
user
- to check entity withentity
- the entity to check withCollection<Long> getFavouriteIds(ApplicationUser user, SharedEntity.TypeDescriptor<?> entityType)
user
- The user for the associated entitiesentityType
- The type of entities to get. E.g. SearchRequest.ENTITY_TYPECollection<Long> getFavouriteIds(String userKey, SharedEntity.TypeDescriptor<?> entityType)
userKey
- The key of the user for the associated entitiesentityType
- The type of entities to get. E.g. SearchRequest.ENTITY_TYPEvoid removeFavouritesForUser(ApplicationUser user, SharedEntity.TypeDescriptor<?> entityType)
user
- The user with whom to disassociate entities withentityType
- The type of entity to disassociate user with.void removeFavouritesForEntity(SharedEntity entity)
entity
- The entity to remove all associations withvoid updateSequence(ApplicationUser user, List<? extends SharedEntity> favouriteEntities)
shared entities
user
- the user in playfavouriteEntities
- the list specifying the order of the SharedEntity
sCopyright © 2002-2020 Atlassian. All Rights Reserved.