com.mambu.apisdk.services

Class CommentsService

java.lang.Object

com.mambu.apisdk.services.CommentsService

public class CommentsService
extends java.lang.Object

Service class which handles API operations for retrieving and posting comments for Mambu Entities. Posting and Getting Comments for the following entities is currently supported: Client, Group. LoanAccount, SavingsAccount, LoanProduct, SavingsProduct, Branch, Centre, User Comments API currently supports: GET Comments (see MBU-8608 - As a Developer, I'd like to GET comments via APIs) and POST Comment (see MBU-8609 - As a Developer, I need to POST comments via APIs)

Field Summary

Fields

Modifier and Type	Field and Description
protected ServiceExecutor	serviceExecutor

Constructor Summary

Constructors

Constructor and Description
CommentsService(MambuAPIService mambuAPIService) Create a new service

Method Summary

Modifier and Type	Method and Description
com.mambu.core.shared.model.Comment	create(MambuEntityType parentEntity, java.lang.String parentEntityId, com.mambu.core.shared.model.Comment comment) Create new Comment using Comment object.
com.mambu.core.shared.model.Comment	create(MambuEntityType parentEntity, java.lang.String parentEntityId, java.lang.String text) Create new Comment
java.util.List<com.mambu.core.shared.model.Comment>	getComments(MambuEntityType parentEntity, java.lang.String parentId, java.lang.Integer offset, java.lang.Integer limit) Get all Comments for a given parent entity
static MambuEntityType[]	getSupportedEntities() Get supported entity types
static boolean	isSupported(MambuEntityType parentEntityType) Is parent entity type supported by the Comments API

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serviceExecutor

protected ServiceExecutor serviceExecutor

Constructor Detail

CommentsService

@Inject
public CommentsService(MambuAPIService mambuAPIService)

Create a new service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

create

public com.mambu.core.shared.model.Comment create(MambuEntityType parentEntity,
                                                  java.lang.String parentEntityId,
                                                  java.lang.String text)
                                           throws MambuApiException

Create new Comment

Parameters:

parentEntity - MambuEntityType for which comments are retrieved. Example: MambuEntityType.CLIENT for comments owned by Client. Must not be null. Comments for the following entities are currently supported: Client, Group. LoanAccount, SavingsAccount, LoanProduct, SavingsProduct, Branch, Centre, User

parentEntityId - entity id or encoded key for the parent entity. Example, ciinetId for MambuEntityType.CLIENT. Must not be null

text - comment to post. Must not be null

Returns:

created comment

Throws:

MambuApiException

create

public com.mambu.core.shared.model.Comment create(MambuEntityType parentEntity,
                                                  java.lang.String parentEntityId,
                                                  com.mambu.core.shared.model.Comment comment)
                                           throws MambuApiException

Create new Comment using Comment object. Only "text" field is used, other comment fields are ignored for new comments

Parameters:

parentEntity - MambuEntityType for which comments are retrieved. Example: MambuEntityType.CLIENT for comments owned by Client. Must not be null. Comments for the following entities are currently supported: Client, Group. LoanAccount, SavingsAccount, LoanProduct, SavingsProduct, Branch, Centre, User

parentEntityId - entity id or encoded key for the parent entity. Example, ciinetId for MambuEntityType.CLIENT. Must not be null

comment - comment to post. Must not be null. Only "text" field is used

Returns:

created comment

Throws:

MambuApiException

getComments

public java.util.List<com.mambu.core.shared.model.Comment> getComments(MambuEntityType parentEntity,
                                                                       java.lang.String parentId,
                                                                       java.lang.Integer offset,
                                                                       java.lang.Integer limit)
                                                                throws MambuApiException

Get all Comments for a given parent entity

Parameters:

parentEntity - MambuEntityType for which comments are retrieved. MambuEntityType.CLIENT, MambuEntity.BRANCH. Must not be null. Comments for the following entities are currently supported: Client, Group. LoanAccount, SavingsAccount, LoanProduct, SavingsProduct, Branch, Centre, User

parentId - entity id or encoded key for the parent entity. Example, client id for a MambuEntityType.CLIENT. Must not be null

offset - pagination offset

limit - pagination limit

Returns:

a list of comments for the parent entity

Throws:

MambuApiException

getSupportedEntities

public static MambuEntityType[] getSupportedEntities()

Get supported entity types

Returns:

all supported entities

isSupported

public static boolean isSupported(MambuEntityType parentEntityType)

Is parent entity type supported by the Comments API

Parameters:

parentEntityType - Mambu Entity type

Returns:

true if supported