com.box.boxjavalibv2.resourcemanagers

Interface IBoxCommentsManager

All Superinterfaces:

IBoxResourceManager

All Known Implementing Classes:

BoxCommentsManagerImpl

public interface IBoxCommentsManager
extends IBoxResourceManager

Method Summary

Methods

Modifier and Type	Method and Description
BoxComment	addComment(BoxCommentRequestObject requestObject) Add a comment to an item.
BoxComment	addComment(String commentedItemId, IBoxType commentedItemType, String message)
void	deleteComment(String commentId, BoxDefaultRequestObject requestObject) Delete a comment.
BoxComment	getComment(String commentId, BoxDefaultRequestObject requestObject) Get a comment, given a comment id.
BoxComment	updateComment(String commentId, BoxCommentRequestObject requestObject) Update a comment.

Method Detail

addComment

BoxComment addComment(BoxCommentRequestObject requestObject)
                      throws BoxRestException,
                             BoxServerException,
                             AuthFatalFailureException

Add a comment to an item.

Parameters:

requestObject - comment request object.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

addComment

BoxComment addComment(String commentedItemId,
                    IBoxType commentedItemType,
                    String message)
                      throws BoxRestException,
                             BoxServerException,
                             AuthFatalFailureException

Throws:

BoxRestException

BoxServerException

AuthFatalFailureException

getComment

BoxComment getComment(String commentId,
                    BoxDefaultRequestObject requestObject)
                      throws BoxRestException,
                             BoxServerException,
                             AuthFatalFailureException

Get a comment, given a comment id.

Parameters:

commentId - id of the comment

requestObject - object that goes into request.

Returns:

comment

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

updateComment

BoxComment updateComment(String commentId,
                       BoxCommentRequestObject requestObject)
                         throws BoxRestException,
                                BoxServerException,
                                AuthFatalFailureException

Update a comment.

Parameters:

commentId - id of the comment

requestObject - comment request object.s

Returns:

comment

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.

deleteComment

void deleteComment(String commentId,
                 BoxDefaultRequestObject requestObject)
                   throws BoxRestException,
                          BoxServerException,
                          AuthFatalFailureException

Delete a comment.

Parameters:

commentId - id of the comment

requestObject - object that goes into request.

Throws:

BoxRestException - See BoxRestException for more info.

BoxServerException - See com.box.restclientv2.exceptions.BoxServerException for more info.

AuthFatalFailureException - See com.box.restclientv2.exceptions.AuthFatalFailureException for more info.