Skip navigation links
A C D E G H I M O R S T U V 

A

AbstractAverageRatingEvent - Class in org.xwiki.ratings.events
Abstract event for AverageRating updates.
AbstractAverageRatingEvent() - Constructor for class org.xwiki.ratings.events.AbstractAverageRatingEvent
Default constructor.
AbstractAverageRatingEvent(AverageRating, float, int) - Constructor for class org.xwiki.ratings.events.AbstractAverageRatingEvent
Default constructor.
AbstractRatingEvent - Class in org.xwiki.ratings.events
Abstract helper for all rating events.
AbstractRatingEvent(Rating) - Constructor for class org.xwiki.ratings.events.AbstractRatingEvent
Default constructor.
AbstractScriptRatingsManager - Class in org.xwiki.ratings.script
This abstract class contains all the public method to be used in RatingsScriptService.
AbstractScriptRatingsManager() - Constructor for class org.xwiki.ratings.script.AbstractScriptRatingsManager
 
addRating(int) - Method in interface org.xwiki.ratings.AverageRating
Update the average rating by adding a new rating.
AverageRating - Interface in org.xwiki.ratings
General interface to provide information about average rating notation.

C

countRatings(Map<RatingsManager.RatingQueryField, Object>) - Method in interface org.xwiki.ratings.RatingsManager
Retrieve the number of ratings matching the given parameters but without retrieving them directly.
CreatedRatingEvent - Class in org.xwiki.ratings.events
Event sent whenever a new Rating is recorded.
CreatedRatingEvent(Rating) - Constructor for class org.xwiki.ratings.events.CreatedRatingEvent
Default constructor.

D

DEFAULT_APP_HINT - Static variable in interface org.xwiki.ratings.RatingsManagerFactory
The hint of the Ratings Manager to use for the default Ratings Application.
DefaultScriptRatingsManager - Class in org.xwiki.ratings.script
This class only defines a component using methods defined in AbstractScriptRatingsManager.
DefaultScriptRatingsManager() - Constructor for class org.xwiki.ratings.script.DefaultScriptRatingsManager
 
DeletedRatingEvent - Class in org.xwiki.ratings.events
Event sent whenever a Rating is deleted.
DeletedRatingEvent(Rating) - Constructor for class org.xwiki.ratings.events.DeletedRatingEvent
Default constructor.

E

equals(Object) - Method in class org.xwiki.ratings.events.AbstractAverageRatingEvent
 
equals(Object) - Method in class org.xwiki.ratings.events.AbstractRatingEvent
 
equals(Object) - Method in class org.xwiki.ratings.events.UpdatedRatingEvent
 

G

get(String) - Method in class org.xwiki.ratings.script.RatingsScriptService
Retrieve a specific DefaultScriptRatingsManager for the given hint.
getAuthor() - Method in interface org.xwiki.ratings.Rating
 
getAverageRating(EntityReference) - Method in interface org.xwiki.ratings.RatingsManager
Retrieve the average rating information of the given reference.
getAverageRating(EntityReference) - Method in class org.xwiki.ratings.script.AbstractScriptRatingsManager
 
getAverageRating(EntityReference) - Method in interface org.xwiki.ratings.script.RatingsScriptServiceAPI
Retrieve the average rating of a specific reference.
getAverageRatingStorageHint() - Method in interface org.xwiki.ratings.RatingsConfiguration
 
getAverageVote() - Method in interface org.xwiki.ratings.AverageRating
 
getConfiguration() - Method in class org.xwiki.ratings.script.AbstractScriptRatingsManager
 
getConfiguration() - Method in interface org.xwiki.ratings.script.RatingsScriptServiceAPI
 
getCreatedAt() - Method in interface org.xwiki.ratings.Rating
 
getCurrentUserRatings(int, int, boolean) - Method in class org.xwiki.ratings.script.AbstractScriptRatingsManager
 
getCurrentUserRatings(int, int, boolean) - Method in interface org.xwiki.ratings.script.RatingsScriptServiceAPI
Retrieve all the ratings of the current user.
getExcludedReferencesFromRatings() - Method in interface org.xwiki.ratings.RatingsConfiguration
Allow to define a set of references that cannot be rated.
getFieldName() - Method in enum org.xwiki.ratings.RatingsManager.RatingQueryField
 
getId() - Method in interface org.xwiki.ratings.AverageRating
 
getId() - Method in interface org.xwiki.ratings.Rating
 
getIdentifier() - Method in interface org.xwiki.ratings.RatingsManager
 
getInstantiatedManagers() - Method in interface org.xwiki.ratings.RatingsManagerFactory
Retrieve the list of instantiated managers from the factory.
getManagerId() - Method in interface org.xwiki.ratings.AverageRating
 
getManagerId() - Method in interface org.xwiki.ratings.Rating
 
getNbVotes() - Method in interface org.xwiki.ratings.AverageRating
 
getNewAverageRating() - Method in class org.xwiki.ratings.events.AbstractAverageRatingEvent
 
getOldAverageVote() - Method in class org.xwiki.ratings.events.AbstractAverageRatingEvent
 
getOldTotalVote() - Method in class org.xwiki.ratings.events.AbstractAverageRatingEvent
 
getOldVote() - Method in class org.xwiki.ratings.events.UpdatedRatingEvent
 
getRating() - Method in class org.xwiki.ratings.events.AbstractRatingEvent
 
getRating(EntityReference, UserReference) - Method in class org.xwiki.ratings.script.AbstractScriptRatingsManager
 
getRating(EntityReference, UserReference) - Method in interface org.xwiki.ratings.script.RatingsScriptServiceAPI
Retrieve the rating performed by the given author on the given reference.
getRatingConfiguration() - Method in interface org.xwiki.ratings.RatingsManager
 
getRatings(Map<RatingsManager.RatingQueryField, Object>, int, int, RatingsManager.RatingQueryField, boolean) - Method in interface org.xwiki.ratings.RatingsManager
Retrieve the list of ratings based on the given query parameters.
getRatings(EntityReference, int, int) - Method in class org.xwiki.ratings.script.AbstractScriptRatingsManager
 
getRatings(EntityReference, int, int, boolean) - Method in class org.xwiki.ratings.script.AbstractScriptRatingsManager
 
getRatings(EntityReference, int, int) - Method in interface org.xwiki.ratings.script.RatingsScriptServiceAPI
Retrieve ratings information for the given reference on the given manager.
getRatings(EntityReference, int, int, boolean) - Method in interface org.xwiki.ratings.script.RatingsScriptServiceAPI
Retrieve ratings information for the given reference on the given manager.
getRatingsManager(String) - Method in interface org.xwiki.ratings.RatingsManagerFactory
Create or retrieve an instance of RatingsManager for the given managerName.
getRatingsStorageHint() - Method in interface org.xwiki.ratings.RatingsConfiguration
 
getReference() - Method in interface org.xwiki.ratings.AverageRating
 
getReference() - Method in interface org.xwiki.ratings.Rating
 
getScale() - Method in interface org.xwiki.ratings.RatingsManager
 
getScaleUpperBound() - Method in interface org.xwiki.ratings.AverageRating
 
getScaleUpperBound() - Method in interface org.xwiki.ratings.Rating
 
getScaleUpperBound() - Method in interface org.xwiki.ratings.RatingsConfiguration
 
getUpdatedAt() - Method in interface org.xwiki.ratings.AverageRating
 
getUpdatedAt() - Method in interface org.xwiki.ratings.Rating
 
getVote() - Method in interface org.xwiki.ratings.Rating
 

H

hasDedicatedCore() - Method in interface org.xwiki.ratings.RatingsConfiguration
 
hashCode() - Method in class org.xwiki.ratings.events.AbstractAverageRatingEvent
 
hashCode() - Method in class org.xwiki.ratings.events.AbstractRatingEvent
 
hashCode() - Method in class org.xwiki.ratings.events.UpdatedRatingEvent
 

I

initialize() - Method in class org.xwiki.ratings.script.RatingsScriptService
 
isAverageStored() - Method in interface org.xwiki.ratings.RatingsConfiguration
 
isEnabled() - Method in interface org.xwiki.ratings.RatingsConfiguration
 
isExcludedFromRatings(EntityReference) - Method in class org.xwiki.ratings.script.AbstractScriptRatingsManager
 
isExcludedFromRatings(EntityReference) - Method in interface org.xwiki.ratings.script.RatingsScriptServiceAPI
Define if the given reference is excluded from ratings.
isZeroStored() - Method in interface org.xwiki.ratings.RatingsConfiguration
 

M

matches(Object) - Method in class org.xwiki.ratings.events.CreatedRatingEvent
 
matches(Object) - Method in class org.xwiki.ratings.events.DeletedRatingEvent
 
matches(Object) - Method in class org.xwiki.ratings.events.UpdateAverageRatingFailedEvent
 
matches(Object) - Method in class org.xwiki.ratings.events.UpdatedAverageRatingEvent
 
matches(Object) - Method in class org.xwiki.ratings.events.UpdatedRatingEvent
 
matches(Object) - Method in class org.xwiki.ratings.events.UpdatingAverageRatingEvent
 
moveRatings(EntityReference, EntityReference) - Method in interface org.xwiki.ratings.RatingsManager
Update all ratings concerning the given reference to point to the new reference.

O

org.xwiki.ratings - package org.xwiki.ratings
 
org.xwiki.ratings.events - package org.xwiki.ratings.events
 
org.xwiki.ratings.script - package org.xwiki.ratings.script
 

R

Rating - Interface in org.xwiki.ratings
Generic interface of what should be available in a Rating.
RatingsConfiguration - Interface in org.xwiki.ratings
Configuration of RatingsManager.
RatingsException - Exception in org.xwiki.ratings
Generic exception for Rating API.
RatingsException(String) - Constructor for exception org.xwiki.ratings.RatingsException
Default constructor with message.
RatingsException(String, Throwable) - Constructor for exception org.xwiki.ratings.RatingsException
Default constructor with message and parent exception.
RatingsManager - Interface in org.xwiki.ratings
Manager for handling Rating operations.
RatingsManager.RatingQueryField - Enum in org.xwiki.ratings
The fields to be used for performing queries on Ratings.
RatingsManagerFactory - Interface in org.xwiki.ratings
Allow to create dedicated instances of RatingsManager for any rating usage.
RatingsScriptService - Class in org.xwiki.ratings.script
Script service to manipulate ratings for different ratings hints.
RatingsScriptService() - Constructor for class org.xwiki.ratings.script.RatingsScriptService
 
RatingsScriptServiceAPI - Interface in org.xwiki.ratings.script
Defines the available methods for RatingsScriptService.
recomputeAverageRating(EntityReference) - Method in interface org.xwiki.ratings.RatingsManager
Compute back the average rating for all the ratings existing for the given reference.
removeRating(int) - Method in interface org.xwiki.ratings.AverageRating
Update the average rating by removing the given rating.
removeRating(String) - Method in interface org.xwiki.ratings.RatingsManager
Remove a rating based on its identifier.
removeRatings(EntityReference) - Method in interface org.xwiki.ratings.RatingsManager
Remove all ratings concerning the given reference.

S

saveRating(EntityReference, UserReference, int) - Method in interface org.xwiki.ratings.RatingsManager
Save and return a Rating information.
saveRating(Rating) - Method in interface org.xwiki.ratings.RatingsManager
This method performs a direct save of the rating specified in parameter.
setIdentifier(String) - Method in interface org.xwiki.ratings.RatingsManager
Allows to set the identifier of the manager.
setRating(EntityReference, int) - Method in class org.xwiki.ratings.script.AbstractScriptRatingsManager
 
setRating(EntityReference, UserReference, int) - Method in class org.xwiki.ratings.script.AbstractScriptRatingsManager
 
setRating(EntityReference, int) - Method in interface org.xwiki.ratings.script.RatingsScriptServiceAPI
Allows to save a rating for the given reference, with the current user reference.
setRating(EntityReference, UserReference, int) - Method in interface org.xwiki.ratings.script.RatingsScriptServiceAPI
Allows to save a rating for the given reference, with the given user reference.
setRatingConfiguration(RatingsConfiguration) - Method in interface org.xwiki.ratings.RatingsManager
Allows to set the configuration of the manager.

T

toString() - Method in class org.xwiki.ratings.events.AbstractAverageRatingEvent
 
toString() - Method in class org.xwiki.ratings.events.AbstractRatingEvent
 
toString() - Method in class org.xwiki.ratings.events.UpdatedRatingEvent
 

U

UpdateAverageRatingFailedEvent - Class in org.xwiki.ratings.events
Event sent whenever an update of AverageRating failed.
UpdateAverageRatingFailedEvent() - Constructor for class org.xwiki.ratings.events.UpdateAverageRatingFailedEvent
Default constructor.
UpdateAverageRatingFailedEvent(AverageRating, float, int) - Constructor for class org.xwiki.ratings.events.UpdateAverageRatingFailedEvent
Default constructor.
UpdatedAverageRatingEvent - Class in org.xwiki.ratings.events
Event sent whenever an AverageRating is updated.
UpdatedAverageRatingEvent() - Constructor for class org.xwiki.ratings.events.UpdatedAverageRatingEvent
Default constructor.
UpdatedAverageRatingEvent(AverageRating, float, int) - Constructor for class org.xwiki.ratings.events.UpdatedAverageRatingEvent
Default constructor.
UpdatedRatingEvent - Class in org.xwiki.ratings.events
Event sent whenever a Rating is updated.
UpdatedRatingEvent(Rating, int) - Constructor for class org.xwiki.ratings.events.UpdatedRatingEvent
Default constructor.
updateRating(int, int) - Method in interface org.xwiki.ratings.AverageRating
Update the average rating by performing a change in an existing rating.
UpdatingAverageRatingEvent - Class in org.xwiki.ratings.events
Event sent whenever an AverageRating is updated.
UpdatingAverageRatingEvent() - Constructor for class org.xwiki.ratings.events.UpdatingAverageRatingEvent
Default constructor.
UpdatingAverageRatingEvent(AverageRating, float, int) - Constructor for class org.xwiki.ratings.events.UpdatingAverageRatingEvent
Default constructor.

V

valueOf(String) - Static method in enum org.xwiki.ratings.RatingsManager.RatingQueryField
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.xwiki.ratings.RatingsManager.RatingQueryField
Returns an array containing the constants of this enum type, in the order they are declared.
A C D E G H I M O R S T U V 
Skip navigation links

Copyright © 2004–2021 XWiki. All rights reserved.