com.atlassian.jira.favourites

Class DefaultFavouritesManager

java.lang.Object

com.atlassian.jira.favourites.DefaultFavouritesManager

All Implemented Interfaces:

FavouritesManager<SharedEntity>

public class DefaultFavouritesManager
extends Object
implements FavouritesManager<SharedEntity>

Constructor Summary

Constructors

Constructor and Description
DefaultFavouritesManager(FavouritesStore store, SharedEntityAccessor.Factory sharedEntityAccessorFactory, ShareManager shareManager)

Method Summary

Modifier and Type	Method and Description
void	addFavourite(ApplicationUser user, SharedEntity entity) Add the given entity as a favourite of the user passed in add to favourites count if necessary.
void	addFavouriteInPosition(ApplicationUser user, SharedEntity entity, long position) Add the given entity as a favourite of the user passed in, in the specified position, add to favourites count if necessary.
void	decreaseFavouriteSequence(ApplicationUser user, SharedEntity entity) Decreases the position of the SharedEntity relative to the user's set of all other entities of the same type.
Collection<Long>	getFavouriteIds(ApplicationUser user, SharedEntity.TypeDescriptor<SharedEntity> entityType) Get the ids of a user's favourite Entities for a given entity type
void	increaseFavouriteSequence(ApplicationUser user, SharedEntity entity) Increases the position of the SharedEntity relative to the user's set of all other entities of the same type.
boolean	isFavourite(ApplicationUser user, SharedEntity entity) Check to see if the given entity is a favourite of the user passed in.
void	moveToEndFavouriteSequence(ApplicationUser user, SharedEntity entity) Moves the position of the SharedEntity to the end relative to the user's set of all other entities of the same type.
void	moveToStartFavouriteSequence(ApplicationUser user, SharedEntity entity) Moves the position of the SharedEntity to the start relative to the user's set of all other entities of the same type.
void	removeFavourite(ApplicationUser user, SharedEntity entity) Remove the given entity as a favourite of the user passed in.
void	removeFavouritesForEntityDelete(SharedEntity entity) Remove all favourite associations for a given entity for entity deletion.
void	removeFavouritesForUser(ApplicationUser user, SharedEntity.TypeDescriptor<SharedEntity> entityType) Remove the favourite associations for the given User and the given type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultFavouritesManager

public DefaultFavouritesManager(FavouritesStore store,
                                SharedEntityAccessor.Factory sharedEntityAccessorFactory,
                                ShareManager shareManager)

Method Detail

addFavourite

public void addFavourite(ApplicationUser user,
                         SharedEntity entity)
                  throws PermissionException

Description copied from interface: FavouritesManager

Add the given entity as a favourite of the user passed in add to favourites count if necessary.

Specified by:

addFavourite in interface FavouritesManager<SharedEntity>

Parameters:

user - The user adding the favourite

entity - The entity to favourite

Throws:

PermissionException - when trying to add a filter as favourite when you have no permissions

addFavouriteInPosition

public void addFavouriteInPosition(ApplicationUser user,
                                   SharedEntity entity,
                                   long position)
                            throws PermissionException

Description copied from interface: FavouritesManager

Add the given entity as a favourite of the user passed in, in the specified position, add to favourites count if necessary. The entity currently in the specified position and all those after will be moved down one position.

Specified by:

addFavouriteInPosition in interface FavouritesManager<SharedEntity>

Parameters:

user - The user adding the favourite

entity - The entity to favourite

position - the position in which this entity should be added in the favourites order.

Throws:

PermissionException - when trying to add a filter as favourite when you have no permissions

removeFavourite

public void removeFavourite(ApplicationUser user,
                            SharedEntity entity)

Description copied from interface: FavouritesManager

Remove the given entity as a favourite of the user passed in. Remove even if user doesn't have permission to see it and adjust count of favourites if necessary.

Specified by:

removeFavourite in interface FavouritesManager<SharedEntity>

Parameters:

user - The user removing the favourite

entity - The entity to favourite

isFavourite

public boolean isFavourite(ApplicationUser user,
                           SharedEntity entity)
                    throws PermissionException

Description copied from interface: FavouritesManager

Check to see if the given entity is a favourite of the user passed in.

Specified by:

isFavourite in interface FavouritesManager<SharedEntity>

Parameters:

user - The user checking the favourite

entity - The entity to favourite

Returns:

true if the entity is favourite and can be seen by user, otherwise false

Throws:

PermissionException - when checking a filter with no permission

getFavouriteIds

public Collection<Long> getFavouriteIds(ApplicationUser user,
                                        SharedEntity.TypeDescriptor<SharedEntity> entityType)

Description copied from interface: FavouritesManager

Get the ids of a user's favourite Entities for a given entity type

Specified by:

getFavouriteIds in interface FavouritesManager<SharedEntity>

Parameters:

user - The user for the associated entities. Can not be null.

entityType - The type of entities to get. E.g. SearchRequest.ENTITY_TYPE. Can not be null.

Returns:

A Collection on Longs that represent the entities, sorted into sequence order

removeFavouritesForUser

public void removeFavouritesForUser(ApplicationUser user,
                                    SharedEntity.TypeDescriptor<SharedEntity> entityType)

Description copied from interface: FavouritesManager

Remove the favourite associations for the given User and the given type

Specified by:

removeFavouritesForUser in interface FavouritesManager<SharedEntity>

Parameters:

user - The ApplicationUser with whom to disassociate entities

entityType - The type of entity to disassociate user with.

removeFavouritesForEntityDelete

public void removeFavouritesForEntityDelete(SharedEntity entity)

Description copied from interface: FavouritesManager

Remove all favourite associations for a given entity for entity deletion. This method is for only for when an entity is deleted as it does not adjust favourite counts.

Specified by:

removeFavouritesForEntityDelete in interface FavouritesManager<SharedEntity>

Parameters:

entity - The entity that is being deleted

increaseFavouriteSequence

public void increaseFavouriteSequence(ApplicationUser user,
                                      SharedEntity entity)
                               throws PermissionException

Description copied from interface: FavouritesManager

Increases the position of the SharedEntity relative to the user's set of all other entities of the same type.

Specified by:

increaseFavouriteSequence in interface FavouritesManager<SharedEntity>

Parameters:

user - the user whom the entity belongs to

entity - The entity in question

Throws:

PermissionException - when the user does not have permission to perform the action.

decreaseFavouriteSequence

public void decreaseFavouriteSequence(ApplicationUser user,
                                      SharedEntity entity)
                               throws PermissionException

Description copied from interface: FavouritesManager

Decreases the position of the SharedEntity relative to the user's set of all other entities of the same type.

Specified by:

decreaseFavouriteSequence in interface FavouritesManager<SharedEntity>

Parameters:

user - the user whom the entity belongs to

entity - The entity in question

Throws:

PermissionException - when the user does not have permission to perform the action.

moveToStartFavouriteSequence

public void moveToStartFavouriteSequence(ApplicationUser user,
                                         SharedEntity entity)
                                  throws PermissionException

Description copied from interface: FavouritesManager

Moves the position of the SharedEntity to the start relative to the user's set of all other entities of the same type.

Specified by:

moveToStartFavouriteSequence in interface FavouritesManager<SharedEntity>

Parameters:

user - the user whom the entity belongs to

entity - The entity in question

Throws:

PermissionException - when the user does not have permission to perform the action.

moveToEndFavouriteSequence

public void moveToEndFavouriteSequence(ApplicationUser user,
                                       SharedEntity entity)
                                throws PermissionException

Description copied from interface: FavouritesManager

Moves the position of the SharedEntity to the end relative to the user's set of all other entities of the same type.

Specified by:

moveToEndFavouriteSequence in interface FavouritesManager<SharedEntity>

Parameters:

user - the user whom the entity belongs to

entity - The entity in question

Throws:

PermissionException - when the user does not have permission to perform the action.