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

Class CustomRatingsServiceImpl

java.lang.Object

org.alfresco.mobile.android.api.services.impl.AlfrescoService

org.alfresco.mobile.android.api.services.impl.AbstractRatingsService

org.alfresco.mobile.android.api.services.impl.onpremise.OnPremiseRatingsServiceImpl

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

All Implemented Interfaces:

android.os.Parcelable, RatingService, Service, CustomRatingsService

public class CustomRatingsServiceImpl
extends OnPremiseRatingsServiceImpl
implements CustomRatingsService

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 class org.alfresco.mobile.android.api.services.impl.onpremise.OnPremiseRatingsServiceImpl

CREATOR

Fields inherited from class org.alfresco.mobile.android.api.services.impl.AlfrescoService

CONTENT_CACHE, RENDITION_CACHE, session

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
CustomRatingsServiceImpl(RepositorySession repositorySession) Default constructor.

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 class org.alfresco.mobile.android.api.services.impl.onpremise.OnPremiseRatingsServiceImpl

computeIsRated, computeRatingsCount, getRatingsObject, getRatingsUrl, getUnlikeUrl

Methods inherited from class org.alfresco.mobile.android.api.services.impl.AbstractRatingsService

getLikeCount, isLiked, like, unlike

Methods inherited from class org.alfresco.mobile.android.api.services.impl.AlfrescoService

clear, convertException, convertNode, convertNode, convertStatusCode, delete, describeContents, getHttpInvoker, getSessionHttp, isCloudSession, isListNull, isMapNull, isObjectNull, isOnPremiseSession, isStringNull, post, put, read, saveContentStream, writeToParcel

Methods inherited from class java.lang.Object

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

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

Constructor Detail

CustomRatingsServiceImpl

public CustomRatingsServiceImpl(RepositorySession repositorySession)

Default constructor. Used by ServiceRegistry

Parameters:

repositorySession -

Method Detail

applyStarRating

public void applyStarRating(Node node,
                   float rating)

Apply 5 star rating to the specified node.

Specified by:

applyStarRating in interface CustomRatingsService

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

public StarRating getStarRating(Node node)

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

Specified by:

getStarRating in interface CustomRatingsService

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

public float getUserStarRatingValue(Node node)

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

Specified by:

getUserStarRatingValue in interface CustomRatingsService

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.