org.alfresco.mobile.android.api.services

Interface CommentService

All Superinterfaces:

android.os.Parcelable, Service

All Known Implementing Classes:

AbstractCommentService, CloudCommentServiceImpl, OnPremiseCommentServiceImpl, PublicAPICommentServiceImpl

public interface CommentService
extends Service

CommentService allows managing comments to any node inside an Alfresco repository.
There are various methods relating to the CommentService, including the ability to:

• Manage comments against nodes
• Get existing comments
• Post new comments
• Delete comments

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

Modifier and Type	Field and Description
static String	SORT_PROPERTY_CREATED_AT Allowable sorting property : Creation Date

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

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).
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.
Comment	updateComment(Node node, Comment comment, String content) Updates the given comment with the provided content.

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

clear

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

SORT_PROPERTY_CREATED_AT

static final String SORT_PROPERTY_CREATED_AT

Allowable sorting property : Creation Date

Method Detail

getComments

List<Comment> getComments(Node node)

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

Parameters:

node - : Node object (Folder or Document).

Returns:

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

Throws:

AlfrescoServiceException - : GENERAL_NOT_FOUND : if node doesn't exist.

AlfrescoServiceException - : ErrorCodeRegistry.GENERAL_UNKNOWN : If network problems occur during the process.

getComments

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

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

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.

Throws:

AlfrescoServiceException - : If node is not defined or if network or internal problems occur during the process.

addComment

Comment addComment(Node node,
                 String content)

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

Parameters:

node - : Node object (Folder or Document).

content - : Comment Content

Returns:

the newly created comment object.

Throws:

AlfrescoServiceException - : If content or node is not defined or if network or internal problems occur during the process.

updateComment

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

Updates the given comment with the provided content.

Parameters:

comment - : new content of a comment.

Returns:

the updated comment object.

Throws:

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

deleteComment

void deleteComment(Node node,
                 Comment comment)

Remove the specified comment from the repository.

Parameters:

Comment - : comment object.

Throws:

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