public class

CommentServiceClient

extends AbstractServiceClient
implements CommentService
java.lang.Object
   ↳ org.mule.LiquidPlanner.client.services.impl.AbstractServiceClient
     ↳ org.mule.LiquidPlanner.client.services.impl.CommentServiceClient

Class Overview

Provide access to all the comments's related operations in LiquidPlanner.

Summary

[Expand]
Inherited Constants
From class org.mule.LiquidPlanner.client.services.impl.AbstractServiceClient
[Expand]
Inherited Fields
From class org.mule.LiquidPlanner.client.services.impl.AbstractServiceClient
Public Constructors
CommentServiceClient(String user, String password)
Public Methods
Comment createComment(String workSpaceId, Comment comment)
Comment deleteComment(String workSpaceId, String commentId)
Comment getComment(String workSpaceId, String commentId)
List<Comment> getComments(String workSpaceId)
Comment updateComment(String workSpaceId, Comment comment)
Protected Methods
String extendGetBaseUrl(String baseUrl)
This method is called by getBaseURL for the user to extend the base URL of its ServiceClient implementation.
ClientConfig getJerseyClientConfiguration()
This method is called by getBuilder before the creation of the Client.
List<ClientFilter> getJerseyClientFilters()
This method is called by getBuilder before the creation of the Client.
[Expand]
Inherited Methods
From class org.mule.LiquidPlanner.client.services.impl.AbstractServiceClient
From class java.lang.Object
From interface org.mule.LiquidPlanner.client.services.CommentService

Public Constructors

public CommentServiceClient (String user, String password)

Parameters
user
password

Public Methods

public Comment createComment (String workSpaceId, Comment comment)

Parameters
workSpaceId
comment

public Comment deleteComment (String workSpaceId, String commentId)

Parameters
workSpaceId
commentId

public Comment getComment (String workSpaceId, String commentId)

Parameters
workSpaceId
commentId

public List<Comment> getComments (String workSpaceId)

Parameters
workSpaceId

public Comment updateComment (String workSpaceId, Comment comment)

Parameters
workSpaceId
comment

Protected Methods

protected String extendGetBaseUrl (String baseUrl)

This method is called by getBaseURL for the user to extend the base URL of its ServiceClient implementation.

Parameters
baseUrl The URL created by getBaseURL
Returns
  • the enhanced base URL

protected ClientConfig getJerseyClientConfiguration ()

This method is called by getBuilder before the creation of the Client. The ClientConfig is used to create the Client.

Returns
  • null if there are ClientConfig to be added.

protected List<ClientFilter> getJerseyClientFilters ()

This method is called by getBuilder before the creation of the Client. The ClientFilter is used to create the Client. If there are no ClientFilter to be added just return null.

Returns
  • null if there are no ClientFilter to be added.