com.mambu.apisdk.services

Class ActivitiesService

java.lang.Object

com.mambu.apisdk.services.ActivitiesService

public class ActivitiesService
extends java.lang.Object

Service class which handles activities API operations like getting activities for Mambu entities. See full Activities API documentation at @http://api.mambu.com/customer/portal/articles/1453628-activities-api?b_id=874

Constructor Summary

Constructors

Constructor and Description
ActivitiesService(MambuAPIService mambuAPIService) Create a new activities service

Method Summary

Modifier and Type	Method and Description
java.util.List<com.mambu.api.server.handler.activityfeed.model.JSONActivity>	getActivities(java.util.Date fromDate, java.util.Date toDate) A convenience method to GET All activities within a specified date interval
java.util.List<com.mambu.api.server.handler.activityfeed.model.JSONActivity>	getActivities(java.util.Date fromDate, java.util.Date toDate, java.lang.Class mambuEntity, java.lang.String entityId) GET all activity feed items within a specified date interval and (optionally) for a specified Mambu entity Allows retrieving a list of activities within a date range which can be filtered by entity key.
java.util.List<com.mambu.api.server.handler.activityfeed.model.JSONActivity>	getActivities(java.util.Date fromDate, java.util.Date toDate, java.lang.Class mambuEntity, java.lang.String entityId, java.lang.Integer offset, java.lang.Integer limit) GET all activity feed items within a specified date interval and (optionally) for a specified Mambu entity Allows retrieving a list of activities within a date range which can be filtered by entity key.
java.util.List<com.mambu.api.server.handler.activityfeed.model.JSONActivity>	getActivities(java.util.Date fromDate, java.util.Date toDate, java.lang.Integer offset, java.lang.Integer limit) A convenience method to GET All activities within a specified date interval

Methods inherited from class java.lang.Object

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

Constructor Detail

ActivitiesService

@Inject
public ActivitiesService(MambuAPIService mambuAPIService)

Create a new activities service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

getActivities

public java.util.List<com.mambu.api.server.handler.activityfeed.model.JSONActivity> getActivities(java.util.Date fromDate,
                                                                                                  java.util.Date toDate,
                                                                                                  java.lang.Class mambuEntity,
                                                                                                  java.lang.String entityId,
                                                                                                  java.lang.Integer offset,
                                                                                                  java.lang.Integer limit)
                                                                                           throws MambuApiException

GET all activity feed items within a specified date interval and (optionally) for a specified Mambu entity Allows retrieving a list of activities within a date range which can be filtered by entity key.

Parameters:

fromDate - starting date for the time interval (mandatory). Only the full date without time is used, the date is inclusive

toDate - end date for the time interval (mandatory). Only the full date without time is used,the date is inclusive

mambuEntity - Mambu Entity for requested activities. If Mambu entity is null then all available activities for all entities supported by API are returned. The following classes are currently supported: Client, Group, Centre, Branch, LoanProduct, SavingsProduct, LoanAccount, SvaingsAccount, User

entityId - the Id for the Mambu entity for requested activities

offset - offset to start pagination. If null, the default value of 0 (zero) will be used.

limit - page-size. If null, the default value of 50 (fifty) will be used.

Returns:

a list of JSONActivities

Throws:

MambuApiException

getActivities

public java.util.List<com.mambu.api.server.handler.activityfeed.model.JSONActivity> getActivities(java.util.Date fromDate,
                                                                                                  java.util.Date toDate,
                                                                                                  java.lang.Class mambuEntity,
                                                                                                  java.lang.String entityId)
                                                                                           throws MambuApiException

GET all activity feed items within a specified date interval and (optionally) for a specified Mambu entity Allows retrieving a list of activities within a date range which can be filtered by entity key.

Parameters:

fromDate - starting date for the time interval (mandatory). Only the full date without time is used, the date is inclusive

toDate - end date for the time interval (mandatory). Only the full date without time is used,the date is inclusive

mambuEntity - Mambu Entity for requested activities. If Mambu entity is null then all available activities for all entities supported by API are returned. The following classes are currently supported: Client, Group, Centre, Branch, LoanProduct, SavingsProduct, LoanAccount, SvaingsAccount, User

entityId - the Id for the Mambu entity for requested activities

Returns:

a list of JSONActivities

Throws:

MambuApiException

getActivities

public java.util.List<com.mambu.api.server.handler.activityfeed.model.JSONActivity> getActivities(java.util.Date fromDate,
                                                                                                  java.util.Date toDate,
                                                                                                  java.lang.Integer offset,
                                                                                                  java.lang.Integer limit)
                                                                                           throws MambuApiException

A convenience method to GET All activities within a specified date interval

Parameters:

fromDate - starting date for the time interval (mandatory).Only the full date without time is used, the date is inclusive

toDate - end date for the time interval (mandatory). Only the full date without time is used,the date is inclusive

offset - offset to start pagination. If null, the default value of 0 (zero) will be used.

limit - page-size. If null, the default value of 50 (fifty) will be used.

Returns:

a list of JSONActivities

Throws:

MambuApiException

getActivities

public java.util.List<com.mambu.api.server.handler.activityfeed.model.JSONActivity> getActivities(java.util.Date fromDate,
                                                                                                  java.util.Date toDate)
                                                                                           throws MambuApiException

A convenience method to GET All activities within a specified date interval

Parameters:

fromDate - starting date for the time interval (mandatory).Only the full date without time is used, the date is inclusive

toDate - end date for the time interval (mandatory). Only the full date without time is used,the date is inclusive

Returns:

a list of JSONActivities

Throws:

MambuApiException