org.alfresco.mobile.android.extension.api.services

Interface CustomRatingsService

All Superinterfaces:

android.os.Parcelable, RatingService, Service

All Known Implementing Classes:

CustomRatingsServiceImpl

public interface CustomRatingsService
extends RatingService

CustomRatingsService overrides SDK ratings to add support of 5 star scheme. There are various methods relating to the CustomRatingsService, including the ability to:

• apply ratings
• retrieve ratings
• retrieve my ratings

Author:

Jean Marie Pascal

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
void	applyStarRating(Node node, float rating) Apply 5 star rating to the specified node.
StarRating	getStarRating(Node node) Get the star ratings value for the specified node (Document or Folder)
float	getUserStarRatingValue(Node node) Get the user star ratings value for the specified node (Document or Folder)

Methods inherited from interface org.alfresco.mobile.android.api.services.RatingService

getLikeCount, isLiked, like, unlike

Methods inherited from interface org.alfresco.mobile.android.api.services.Service

clear

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Method Detail

applyStarRating

void applyStarRating(Node node,
                   float rating)

Apply 5 star rating to the specified node.

Parameters:

node - : Node object (Folder or Document).

rating - : Scale 0 to 5 stars.

Throws:

AlfrescoServiceException - : If comment is not defined or If network problems occur during the process.

getStarRating

StarRating getStarRating(Node node)

Get the star ratings value for the specified node (Document or Folder)

Parameters:

node - : Node object (Folder or Document).

Returns:

StarRatings object that contains all informations about ratings (average value, number...)

Throws:

AlfrescoServiceException - : If comment is not defined or If network problems occur during the process.

getUserStarRatingValue

float getUserStarRatingValue(Node node)

Get the user star ratings value for the specified node (Document or Folder)

Parameters:

node - : Node object (Folder or Document).

Returns:

rating value between 0 to 5.

Throws:

AlfrescoServiceException - : If comment is not defined or If network problems occur during the process.