|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface FavouritesManager<S extends SharedEntity>
Manager for basic Favourites functionality. Used for adding, removing and checking favourites of generic entities. It also adjusts favourite counts for entities
Method Summary | |
---|---|
void |
addFavourite(com.atlassian.crowd.embedded.api.User user,
S entity)
Add the given entity as a favourite of the user passed in add to favourites count if necessary. |
void |
addFavourite(User user,
S entity)
Add the given entity as a favourite of the user passed in add to favourites count if necessary. |
void |
addFavouriteInPosition(com.atlassian.crowd.embedded.api.User user,
S 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 |
addFavouriteInPosition(User user,
S 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(com.atlassian.crowd.embedded.api.User user,
S entity)
Decreases the position of the SharedEntity relative to the user's set of all other entities of the same type. |
void |
decreaseFavouriteSequence(User user,
S entity)
Decreases the position of the SharedEntity relative to the user's set of all other entities of the same type. |
Collection<Long> |
getFavouriteIds(com.atlassian.crowd.embedded.api.User user,
SharedEntity.TypeDescriptor<S> entityType)
Get the ids of a user's favourite Entities for a given entity type |
Collection<Long> |
getFavouriteIds(User user,
SharedEntity.TypeDescriptor<S> entityType)
Get the ids of a user's favourite Entities for a given entity type |
void |
increaseFavouriteSequence(com.atlassian.crowd.embedded.api.User user,
S entity)
Increases the position of the SharedEntity relative to the user's set of all other entities of the same type. |
void |
increaseFavouriteSequence(User user,
S entity)
Increases the position of the SharedEntity relative to the user's set of all other entities of the same type. |
boolean |
isFavourite(com.atlassian.crowd.embedded.api.User user,
S entity)
Check to see if the given entity is a favourite of the user passed in. |
boolean |
isFavourite(User user,
S entity)
Check to see if the given entity is a favourite of the user passed in. |
void |
moveToEndFavouriteSequence(com.atlassian.crowd.embedded.api.User user,
S 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 |
moveToEndFavouriteSequence(User user,
S 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(com.atlassian.crowd.embedded.api.User user,
S 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 |
moveToStartFavouriteSequence(User user,
S 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(com.atlassian.crowd.embedded.api.User user,
S entity)
Remove the given entity as a favourite of the user passed in. |
void |
removeFavourite(User user,
S 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(com.atlassian.crowd.embedded.api.User user,
SharedEntity.TypeDescriptor<S> entityType)
Remove the favourite associations for the given User and the given type |
void |
removeFavouritesForUser(User user,
SharedEntity.TypeDescriptor<S> entityType)
Remove the favourite associations for the given User and the given type |
Method Detail |
---|
void addFavourite(com.atlassian.crowd.embedded.api.User user, S entity) throws PermissionException
user
- The user adding the favouriteentity
- The entity to favourite
PermissionException
- when trying to add a filter as favourite when you have no permissionsvoid addFavourite(User user, S entity) throws PermissionException
user
- The user adding the favouriteentity
- The entity to favourite
PermissionException
- when trying to add a filter as favourite when you have no permissionsvoid addFavouriteInPosition(com.atlassian.crowd.embedded.api.User user, S entity, long position) throws PermissionException
user
- The user adding the favouriteentity
- The entity to favouriteposition
- the position in which this entity should be added in the favourites order.
PermissionException
- when trying to add a filter as favourite when you have no permissionsvoid addFavouriteInPosition(User user, S entity, long position) throws PermissionException
user
- The user adding the favouriteentity
- The entity to favouriteposition
- the position in which this entity should be added in the favourites order.
PermissionException
- when trying to add a filter as favourite when you have no permissionsvoid removeFavourite(com.atlassian.crowd.embedded.api.User user, S entity)
user
- The user removing the favouriteentity
- The entity to favouritevoid removeFavourite(User user, S entity)
user
- The user removing the favouriteentity
- The entity to favouriteboolean isFavourite(com.atlassian.crowd.embedded.api.User user, S entity) throws PermissionException
user
- The user checking the favouriteentity
- The entity to favourite
PermissionException
- when checking a filter with no permissionboolean isFavourite(User user, S entity) throws PermissionException
user
- The user checking the favouriteentity
- The entity to favourite
PermissionException
- when checking a filter with no permissionCollection<Long> getFavouriteIds(com.atlassian.crowd.embedded.api.User user, SharedEntity.TypeDescriptor<S> entityType)
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.
IllegalArgumentException
- for null user or entity typeCollection<Long> getFavouriteIds(User user, SharedEntity.TypeDescriptor<S> entityType)
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.
IllegalArgumentException
- for null user or entity typevoid removeFavouritesForUser(com.atlassian.crowd.embedded.api.User user, SharedEntity.TypeDescriptor<S> entityType)
user
- The user with whom to disassociate entities withentityType
- The type of entity to disassociate user with.void removeFavouritesForUser(User user, SharedEntity.TypeDescriptor<S> entityType)
user
- The user with whom to disassociate entities withentityType
- The type of entity to disassociate user with.void removeFavouritesForEntityDelete(SharedEntity entity)
entity
- The entity that is being deletedvoid increaseFavouriteSequence(com.atlassian.crowd.embedded.api.User user, S entity) throws PermissionException
SharedEntity
relative to the user's set of all other entities of the same type.
user
- the user whom the entity belongs toentity
- The entity in question
PermissionException
- when the user does not have permission to perform the action.void increaseFavouriteSequence(User user, S entity) throws PermissionException
SharedEntity
relative to the user's set of all other entities of the same type.
user
- the user whom the entity belongs toentity
- The entity in question
PermissionException
- when the user does not have permission to perform the action.void decreaseFavouriteSequence(com.atlassian.crowd.embedded.api.User user, S entity) throws PermissionException
SharedEntity
relative to the user's set of all other entities of the same type.
user
- the user whom the entity belongs toentity
- The entity in question
PermissionException
- when the user does not have permission to perform the action.void decreaseFavouriteSequence(User user, S entity) throws PermissionException
SharedEntity
relative to the user's set of all other entities of the same type.
user
- the user whom the entity belongs toentity
- The entity in question
PermissionException
- when the user does not have permission to perform the action.void moveToStartFavouriteSequence(com.atlassian.crowd.embedded.api.User user, S entity) throws PermissionException
SharedEntity
to the start relative to the user's set of all other entities of the same type.
user
- the user whom the entity belongs toentity
- The entity in question
PermissionException
- when the user does not have permission to perform the action.void moveToStartFavouriteSequence(User user, S entity) throws PermissionException
SharedEntity
to the start relative to the user's set of all other entities of the same type.
user
- the user whom the entity belongs toentity
- The entity in question
PermissionException
- when the user does not have permission to perform the action.void moveToEndFavouriteSequence(com.atlassian.crowd.embedded.api.User user, S entity) throws PermissionException
SharedEntity
to the end relative to the user's set of all other entities of the same type.
user
- the user whom the entity belongs toentity
- The entity in question
PermissionException
- when the user does not have permission to perform the action.void moveToEndFavouriteSequence(User user, S entity) throws PermissionException
SharedEntity
to the end relative to the user's set of all other entities of the same type.
user
- the user whom the entity belongs toentity
- The entity in question
PermissionException
- when the user does not have permission to perform the action.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |