|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FavouritesStore
Store used for CRUD of Favourites.
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 |
Method Detail |
---|
boolean addFavourite(com.opensymphony.user.User user, SharedEntity entity)
user
- to associate entity withentity
- the entity to associate with
boolean removeFavourite(com.opensymphony.user.User user, SharedEntity entity)
user
- to disassociate entity withentity
- the entity to disassociate with
boolean isFavourite(com.opensymphony.user.User user, SharedEntity entity)
user
- to check entity withentity
- the entity to check with
java.util.Collection<java.lang.Long> getFavouriteIds(com.opensymphony.user.User user, SharedEntity.TypeDescriptor<?> entityType)
user
- The user for the associated entitiesentityType
- The type of entities to get. E.g. SearchRequest.ENTITY_TYPE
void removeFavouritesForUser(com.opensymphony.user.User 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(com.opensymphony.user.User user, java.util.List<? extends SharedEntity> favouriteEntities)
shared entities
user
- the user in playfavouriteEntities
- the list specifying the order of the SharedEntity
s
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |