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

Class AbstractCommentService

java.lang.Object

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

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

All Implemented Interfaces:

android.os.Parcelable, CommentService, Service

Direct Known Subclasses:

OnPremiseCommentServiceImpl, PublicAPICommentServiceImpl

public abstract class AbstractCommentService
extends AlfrescoService
implements CommentService

Abstract class implementation of CommentService. 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 org.alfresco.mobile.android.api.services.CommentService

SORT_PROPERTY_CREATED_AT

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
AbstractCommentService(AlfrescoSession repositorySession) Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Comment	addComment(Node node, String content) Add a comment to the specified Node (Folder or Document).
protected abstract PagingResult<Comment>	computeComment(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url) Internal method to compute data from server and transform it as high level object.
void	deleteComment(Node node, Comment comment) Remove the specified comment from the repository.
List<Comment>	getComments(Node node) List the available comments for the specified node.
PagingResult<Comment>	getComments(Node node, ListingContext listingContext) List the available comments for the specified node.
protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getCommentsUrl(Node node, ListingContext listingContext, boolean isReadOperation) Internal method to retrieve node comments url.
protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getCommentUrl(Node node, Comment comment) Internal method to retrieve a specific comment url.
protected abstract Comment	parseData(Map<String,Object> json) Parse Json Data response from the repository.
Comment	updateComment(Node node, Comment comment, String content) Updates the given comment with the provided content.

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

AbstractCommentService

public AbstractCommentService(AlfrescoSession repositorySession)

Default Constructor. Only used inside ServiceRegistry.

Parameters:

repositorySession - : Repository Session.

Method Detail

getComments

public List<Comment> getComments(Node node)

List the available comments for the specified node.
Maximum result : 10 by default
Order : Older first

Specified by:

getComments in interface CommentService

Parameters:

node - : Node object (Folder or Document).

Returns:

Returns a list of the available comments for the specified node.

getCommentsUrl

protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder getCommentsUrl(Node node,
                                                                   ListingContext listingContext,
                                                                   boolean isReadOperation)

Internal method to retrieve node comments url. (depending on repository type)

Parameters:

node - : a commented node

listingContext - : define characteristics of the result (Optional for Onpremise)

Returns:

UrlBuilder to retrieve for a specific user node comments url.

getComments

public PagingResult<Comment> getComments(Node node,
                                ListingContext listingContext)

List the available comments for the specified node.
Order supports : CommentService.SORT_PROPERTY_CREATED_AT

Specified by:

getComments in interface CommentService

Parameters:

node - : Node object (Folder or Document).

listingContext - : define characteristics of the result

Returns:

Returns a paged list of the available comments for the specified node.

addComment

public Comment addComment(Node node,
                 String content)

Add a comment to the specified Node (Folder or Document).

Specified by:

addComment in interface CommentService

Parameters:

node - : Node object (Folder or Document).

content - : Comment Content

Returns:

the newly created comment object.

getCommentUrl

protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder getCommentUrl(Node node,
                                                                  Comment comment)

Internal method to retrieve a specific comment url. (depending on repository type)

Parameters:

node - : a commented node

comment - : the comment object (cloud only)

Returns:

UrlBuilder to retrieve for a specific comment url.

updateComment

public Comment updateComment(Node node,
                    Comment comment,
                    String content)

Updates the given comment with the provided content.

Specified by:

updateComment in interface CommentService

comment - : new content of a comment.

Returns:

the updated comment object.

deleteComment

public void deleteComment(Node node,
                 Comment comment)

Remove the specified comment from the repository.

Specified by:

deleteComment in interface CommentService

parseData

protected abstract Comment parseData(Map<String,Object> json)

Parse Json Data response from the repository.

Parameters:

json - : Map of data.

Returns:

the Comment object representative of the data.

computeComment

protected abstract PagingResult<Comment> computeComment(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url)

Internal method to compute data from server and transform it as high level object.

Parameters:

url - : Alfresco REST API activity url

Returns:

Paging Result of Comment.