com.mambu.apisdk.services

Class SearchService

java.lang.Object

com.mambu.apisdk.services.SearchService

public class SearchService
extends java.lang.Object

Service class which handles the API operations available for the Search

Constructor Summary

Constructors

Constructor and Description
SearchService(MambuAPIService mambuAPIService) Create a new search service

Method Summary

Modifier and Type	Method and Description
java.util.List<com.mambu.notifications.shared.model.NotificationMessage>	getNotificationMessages(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Get a history of notification messages by specifying filter constraints
static ApiDefinition	makeApiDefinitionForSearchByFilter(MambuEntityType searchEntityType) Helper to create ApiDefintion for searching entities matching filter criteria
java.util.Map<com.mambu.core.shared.model.SearchType,java.util.List<com.mambu.core.shared.model.SearchResult>>	search(java.lang.String query, java.util.List<com.mambu.core.shared.model.SearchType> searchTypes, java.lang.String limit) Get a Map of search results for a given query and an optional list of search types
<T> java.util.List<T>	searchEntities(MambuEntityType searchEntityType, com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Deprecated.
<T> java.util.List<T>	searchEntitiesWithBasicDetails(MambuEntityType searchEntityType, com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Convenience method to GET Mambu entities by specifying filter constraints.
<T> java.util.List<T>	searchEntitiesWithFullDetails(MambuEntityType searchEntityType, com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints, java.lang.String offset, java.lang.String limit) Convenience method to GET Mambu entities by specifying filter constraints.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchService

@Inject
public SearchService(MambuAPIService mambuAPIService)

Create a new search service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

search

public java.util.Map<com.mambu.core.shared.model.SearchType,java.util.List<com.mambu.core.shared.model.SearchResult>> search(java.lang.String query,
                                                                                                                             java.util.List<com.mambu.core.shared.model.SearchType> searchTypes,
                                                                                                                             java.lang.String limit)
                                                                                                                      throws MambuApiException

Get a Map of search results for a given query and an optional list of search types

Parameters:

query - the string to query

searchTypes - list, in brackets,separated by comma of search types to query. E.g. [CLIENT, GROUP]. Null if searching for all types (defined by SearchType). The results of the query shall be limited to the specified types

limit - maximum number of results to return. If null, Mambu defaults this to 100.

Returns:

Map> is returned. Empty map and/or Mambu exception if not found

Throws:

MambuApiException

searchEntities

@Deprecated
public <T> java.util.List<T> searchEntities(MambuEntityType searchEntityType,
                                                        com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                        java.lang.String offset,
                                                        java.lang.String limit)
                                                 throws MambuApiException

Deprecated.

Convenience method to GET Mambu entities by specifying filter constraints. This generic method can be used to retrieve entities by filter constraints for any supported entity type. API users can also use methods specific to each entity, for example to get clients by filter constraints use ClientsService.getClients(JSONFilterConstraints, String, String)

Note: This method is deprecated, you may use the searchEntitiesWithFullDetails(MambuEntityType, JSONFilterConstraints, String, String) in order to obtain entities with full details (custom fields included) or searchEntitiesWithBasicDetails to obtain the entities in basic details level.

Parameters:

searchEntityType - Mambu entity type. Must not be null. Currently searching with filter constrains API supports the following entities: Clients, Groups, Loans, Savings, Loan Transactions, SavingsTransactions and NotificationMessages

filterConstraints - JSONFilterConstraints object defining an array of applicable filter constraints and an optional sort order. 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:

list of entities of the searchEntityType matching provided filter constraints

Throws:

MambuApiException - in case exception occurs while fetching entities

searchEntitiesWithBasicDetails

public <T> java.util.List<T> searchEntitiesWithBasicDetails(MambuEntityType searchEntityType,
                                                            com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                            java.lang.String offset,
                                                            java.lang.String limit)
                                                     throws MambuApiException

Convenience method to GET Mambu entities by specifying filter constraints. This generic method can be used to retrieve entities by filter constraints for any supported entity type. API users can also use methods specific to each entity, for example to get clients by filter constraints use ClientsService.getClients(JSONFilterConstraints, String, String) Note: the retrieved entities will not contain custom fields. In case custom fields are needed searchEntitiesWithFullDetails(MambuEntityType, JSONFilterConstraints, String, String) must be used

Parameters:

searchEntityType - Mambu entity type. Must not be null. Currently searching with filter constrains API supports the following entities: Clients, Groups, Loans, Savings, Loan Transactions, SavingsTransactions and NotificationMessages

filterConstraints - JSONFilterConstraints object defining an array of applicable filter constraints and an optional sort order. 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:

list of entities of the searchEntityType matching provided filter constraints

Throws:

MambuApiException - in case exception occurs while fetching entities

searchEntitiesWithFullDetails

public <T> java.util.List<T> searchEntitiesWithFullDetails(MambuEntityType searchEntityType,
                                                           com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                           java.lang.String offset,
                                                           java.lang.String limit)
                                                    throws MambuApiException

Convenience method to GET Mambu entities by specifying filter constraints. This generic method can be used to retrieve entities by filter constraints for any supported entity type. API users can also use methods specific to each entity, for example to get clients by filter constraints use ClientsService.getClients(JSONFilterConstraints, String, String)

Parameters:

searchEntityType - Mambu entity type. Must not be null. Currently searching with filter constrains API supports the following entities: Clients, Groups, Loans, Savings, Loan Transactions, SavingsTransactions and NotificationMessages

filterConstraints - JSONFilterConstraints object defining an array of applicable filter constraints and an optional sort order. 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:

list of entities of the searchEntityType matching provided filter constraints

Throws:

MambuApiException - in case exception occurs while fetching entities

makeApiDefinitionForSearchByFilter

public static ApiDefinition makeApiDefinitionForSearchByFilter(MambuEntityType searchEntityType)

Helper to create ApiDefintion for searching entities matching filter criteria

Parameters:

searchEntityType - entity type for searching with filter constraints. Must not be null. Currently API supports the following entities: Clients, Groups, Loans, Savings, Loan Transactions, SavingsTransactions, and NotificationMessages See MBU-8986, MBU-10646, MBU-11120 for more details

Returns:

api definition for searching entities using filter constraints

getNotificationMessages

public java.util.List<com.mambu.notifications.shared.model.NotificationMessage> getNotificationMessages(com.mambu.api.server.handler.core.dynamicsearch.model.JSONFilterConstraints filterConstraints,
                                                                                                        java.lang.String offset,
                                                                                                        java.lang.String limit)
                                                                                                 throws MambuApiException

Get a history of notification messages by specifying filter constraints

Parameters:

filterConstraints - filter constraints. Must not be null. See MBU-10646 for a list of supported constraints

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:

list of notification messages matching filter constraints

Throws:

MambuApiException - in case something wrong happens while getting notification messages