com.mambu.apisdk.services

Class CustomViewsService

java.lang.Object

com.mambu.apisdk.services.CustomViewsService

public class CustomViewsService
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected ServiceExecutor	serviceExecutor

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
<T> java.util.List<T>	getCustomViewEntities(com.mambu.api.server.handler.customviews.model.ApiViewType apiViewType, java.lang.String branchId, boolean fullDetails, java.lang.String customViewKey, java.lang.String offset, java.lang.String limit) Get entities for a Custom View
<T> java.util.List<T>	getCustomViewEntities(com.mambu.api.server.handler.customviews.model.ApiViewType apiViewType, java.lang.String branchId, java.lang.String customViewKey, java.lang.String offset, java.lang.String limit) Convenience method to get "Basic" entities for a Custom View (entities without full details)
com.mambu.api.server.handler.customviews.model.CustomViewEntitiesSummaryWrapper	getCustomViewSummary(com.mambu.api.server.handler.customviews.model.ApiViewType apiViewType, java.lang.String branchId, java.lang.String customViewKey) Get summary for a custom view

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

CustomViewsService

@Inject
public CustomViewsService(MambuAPIService mambuAPIService)

Create a new service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

getCustomViewEntities

public <T> java.util.List<T> getCustomViewEntities(com.mambu.api.server.handler.customviews.model.ApiViewType apiViewType,
                                                   java.lang.String branchId,
                                                   boolean fullDetails,
                                                   java.lang.String customViewKey,
                                                   java.lang.String offset,
                                                   java.lang.String limit)
                                            throws MambuApiException

Get entities for a Custom View

Parameters:

apiViewType - API view type. Example, ApiViewType.LOANS, or ApiViewType.CLIENTS

branchId - an optional branch ID filtering parameter. If null, entities for all branches managed by the API user are retrieved

fullDetails - boolean indicating if entities with fullDetails shall be returned. Applicable to Clients, Groups, Loan Accounts and Savings Accounts

customViewKey - the encoded key for the custom view. Must not be null

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

a list of entities for the custom view

Throws:

MambuApiException

getCustomViewEntities

public <T> java.util.List<T> getCustomViewEntities(com.mambu.api.server.handler.customviews.model.ApiViewType apiViewType,
                                                   java.lang.String branchId,
                                                   java.lang.String customViewKey,
                                                   java.lang.String offset,
                                                   java.lang.String limit)
                                            throws MambuApiException

Convenience method to get "Basic" entities for a Custom View (entities without full details)

Parameters:

apiViewType - API view type. Example, ApiViewType.LOANS, or ApiViewType.CLIENTS

branchId - an optional branch ID filtering parameter. If null, entities for all branches managed by the API user are retrieved

customViewKey - the encoded key for the custom view. Must not be null

offset - pagination offset. If not null it must be an integer greater or equal to zero

limit - pagination limit. If not null it must be an integer greater than zero

Returns:

a list of basic entities for the custom view

Throws:

MambuApiException

getCustomViewSummary

public com.mambu.api.server.handler.customviews.model.CustomViewEntitiesSummaryWrapper getCustomViewSummary(com.mambu.api.server.handler.customviews.model.ApiViewType apiViewType,
                                                                                                            java.lang.String branchId,
                                                                                                            java.lang.String customViewKey)
                                                                                                     throws MambuApiException

Get summary for a custom view

Parameters:

apiViewType - API view type. Example, ApiViewType.LOANS, or ApiViewType.CLIENTS

branchId - an optional branch ID filtering parameter. If null, summary for entities in all branches managed by the API user are retrieved

customViewKey - the encoded key for the custom view. Must not be null

Returns:

custom view summary

Throws:

MambuApiException