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

Class AbstractRatingsService

java.lang.Object

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

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

All Implemented Interfaces:

android.os.Parcelable, RatingService, Service

Direct Known Subclasses:

OnPremiseRatingsServiceImpl, PublicAPIRatingsServiceImpl

public abstract class AbstractRatingsService
extends AlfrescoService
implements RatingService

Abstract class implementation of RatingsService. Responsible of sharing common methods between child class (OnPremise and Cloud)

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.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
AbstractRatingsService(AlfrescoSession repositorySession) Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract boolean	computeIsRated(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url) Internal method to compute data from server and retrieve if the user has rate this node.
protected abstract int	computeRatingsCount(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url) Internal method to compute data from server and retrieve the number of "like".
int	getLikeCount(Node node) Retrieves the number of likes for the specified node
protected abstract org.apache.chemistry.opencmis.commons.impl.json.JSONObject	getRatingsObject() Internal method to retrieve the ratings object from json data
protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getRatingsUrl(Node node) Internal method to retrieve a specific ratings url to like a node.
protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getUnlikeUrl(Node node) Internal method to retrieve a specific ratings url to unlike a node.
boolean	isLiked(Node node) Determine if the current user has liked this node.
void	like(Node node) Increases the like count for the specified node.
void	unlike(Node node) Removes a previous “like” of the specified node.

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.Service

clear

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Constructor Detail

AbstractRatingsService

public AbstractRatingsService(AlfrescoSession repositorySession)

Default Constructor. Only used inside ServiceRegistry.

Parameters:

repositorySession - : Repository Session.

Method Detail

getRatingsUrl

protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder getRatingsUrl(Node node)

Internal method to retrieve a specific ratings url to like a node. (depending on repository type)

Parameters:

node - : a rated node

Returns:

UrlBuilder to retrieve for a specific ratings url.

getRatingsObject

protected abstract org.apache.chemistry.opencmis.commons.impl.json.JSONObject getRatingsObject()

Internal method to retrieve the ratings object from json data

Returns:

JsonObject that contains rating object data.

like

public void like(Node node)

Increases the like count for the specified node.

Specified by:

like in interface RatingService

Parameters:

node - : Node object (Folder or Document).

getUnlikeUrl

protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder getUnlikeUrl(Node node)

Internal method to retrieve a specific ratings url to unlike a node. (depending on repository type)

Parameters:

node - : a rated node

Returns:

UrlBuilder to retrieve for a specific ratings url.

unlike

public void unlike(Node node)

Removes a previous “like” of the specified node.

Specified by:

unlike in interface RatingService

Parameters:

node - : Node object (Folder or Document).

getLikeCount

public int getLikeCount(Node node)

Retrieves the number of likes for the specified node

Specified by:

getLikeCount in interface RatingService

Parameters:

node - : Node object (Folder or Document).

Returns:

Retrieves the number of likes for the specified node.

isLiked

public boolean isLiked(Node node)

Determine if the current user has liked this node.

Specified by:

isLiked in interface RatingService

Parameters:

node - : Node object (Folder or Document).

Returns:

true id the current user has liked this node.

computeRatingsCount

protected abstract int computeRatingsCount(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url)

Internal method to compute data from server and retrieve the number of "like".

Parameters:

url - : Alfresco REST API activity url

Returns:

the number of ratings 'like' on this node.

computeIsRated

protected abstract boolean computeIsRated(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url)

Internal method to compute data from server and retrieve if the user has rate this node.

Parameters:

url - : Alfresco REST API activity url

Returns:

true if the current logged user has like the node.