com.mambu.apisdk.services

Class CustomFieldValueService

java.lang.Object

com.mambu.apisdk.services.CustomFieldValueService

public class CustomFieldValueService
extends java.lang.Object

Service class which handles API operations for patching and deleting Custom Field Values for supported Mambu Entities. Currently supported entities include: Client, Group. LoanAccount, SavingsAccount,Branch, Centre, User, LineOfCredit

Field Summary

Fields

Modifier and Type	Field and Description
protected ServiceExecutor	serviceExecutor

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	addGroupedFields(MambuEntityType parentEntity, java.lang.String parentEntityId, java.util.List<com.mambu.core.shared.model.CustomFieldValue> customFieldValues) Add new grouped custom field values for an entity.
boolean	delete(MambuEntityType parentEntity, java.lang.String parentEntityId, com.mambu.core.shared.model.CustomFieldValue customFieldValue) Delete custom field value for a Mambu parent entity
boolean	delete(MambuEntityType parentEntity, java.lang.String parentEntityId, MambuEntityType ownedEntity, java.lang.String ownedEntityId, com.mambu.core.shared.model.CustomFieldValue customFieldValue) Delete custom field value for owned entity.
static com.mambu.core.shared.model.CustomFieldType	getCustomFieldType(MambuEntityType mambuEntityType) Get CustomFieldType for the corresponding MambuEntityType
java.util.List<com.mambu.core.shared.model.CustomFieldValue>	getCustomFieldValue(MambuEntityType parentEntity, java.lang.String parentEntityId, MambuEntityType ownedEntity, java.lang.String ownedEntityId, java.lang.String customFieldId) Gets a list of CustomFieldValue for the corresponding parent entity type, parentEntityId, ownedEntity type, owned entity id and custom field id.
java.util.List<com.mambu.core.shared.model.CustomFieldValue>	getCustomFieldValue(MambuEntityType parentEntity, java.lang.String parentEntityId, java.lang.String customFieldId) Gets a list of CustomFieldValue for the corresponding parent entity type, parent entity id and custom field id.
static MambuEntityType[]	getSupportedEntities() Get Mambu Entities supporting Custom Field Value API
static boolean	isSupported(MambuEntityType parentEntityType) Is parent entity type supported by the Custom Field Value API
boolean	update(MambuEntityType parentEntity, java.lang.String parentEntityId, com.mambu.core.shared.model.CustomFieldValue customFieldValue) Update custom field value entity.
boolean	update(MambuEntityType parentEntity, java.lang.String parentEntityId, java.util.List<com.mambu.core.shared.model.CustomFieldValue> customFieldValues) Update a list of custom fields
boolean	update(MambuEntityType parentEntity, java.lang.String parentEntityId, MambuEntityType ownedEntity, java.lang.String ownedEntityId, com.mambu.core.shared.model.CustomFieldValue customFieldValue) Update custom field value for owned entity.
boolean	updateGroupedFields(MambuEntityType parentEntity, java.lang.String parentEntityId, java.util.List<com.mambu.core.shared.model.CustomFieldValue> customFieldValues) Update grouped custom field values for an entity.

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

CustomFieldValueService

@Inject
public CustomFieldValueService(MambuAPIService mambuAPIService)

Create a new service

Parameters:

mambuAPIService - the service responsible with the connection to the server

Method Detail

update

public boolean update(MambuEntityType parentEntity,
                      java.lang.String parentEntityId,
                      com.mambu.core.shared.model.CustomFieldValue customFieldValue)
               throws MambuApiException

Update custom field value entity.

Parameters:

parentEntity - Mambu entity for which the custom field value is updated. Example: MambuEntity.CLIENT, MambuEntity.BRANCH

parentEntityId - entity id or encoded key for the parent entity

customFieldValue - custom field value to be updated

Returns:

true if updated successfully

Throws:

MambuApiException

delete

public boolean delete(MambuEntityType parentEntity,
                      java.lang.String parentEntityId,
                      com.mambu.core.shared.model.CustomFieldValue customFieldValue)
               throws MambuApiException

Delete custom field value for a Mambu parent entity

Parameters:

parentEntity - Mambu entity for which custom field value is deleted. Example: MambuEntity.CLIENT, MambuEntity.BRANCH

parentEntityId - entity id or encoded key for the parent entity

customFieldValue - custom field value to be deleted

Returns:

true if successful

Throws:

MambuApiException

update

public boolean update(MambuEntityType parentEntity,
                      java.lang.String parentEntityId,
                      MambuEntityType ownedEntity,
                      java.lang.String ownedEntityId,
                      com.mambu.core.shared.model.CustomFieldValue customFieldValue)
               throws MambuApiException

Update custom field value for owned entity. This methods allows to update custom fields for entities like Transaction, for example, where a parent entity is (e.g. loan) and the actual entity (e.g. transaction) as well as their IDs must be specified. E.g. PATCH "{ "value": "10" }" /api/loans/accountId/transactions/transId/custominformation/{customFieldId} Note: as of Mambu 4.1 updating custom fields only for Loan and Savings transactions is supported

Parameters:

parentEntity - the parent Mambu entity for which the custom field value is updated. Example: MambuEntity.LOAN_ACCOUNT

parentEntityId - entity id or encoded key for the parent entity (e.g. loan account id)

ownedEntity - Mambu entity for which the custom field value is updated. Example: MambuEntity.LOAN_TRANSACTOION

ownedEntityId - the entity id or encoded key for the owned entity (e.g transaction id)

customFieldValue - custom field value to be updated

Returns:

true if updated successfully

Throws:

MambuApiException

delete

public boolean delete(MambuEntityType parentEntity,
                      java.lang.String parentEntityId,
                      MambuEntityType ownedEntity,
                      java.lang.String ownedEntityId,
                      com.mambu.core.shared.model.CustomFieldValue customFieldValue)
               throws MambuApiException

Delete custom field value for owned entity. Used to delete a custom field value where both the parent entity id and type (e.g. loans) and the owned entity id and type (e.g. transaction) must be specified

Parameters:

parentEntity - the parent Mambu entity for which the custom field value is deleted. Example: MambuEntity.LOAN_ACCOUNT

parentEntityId - entity id or encoded key for the parent entity (e.g. loan account id)

ownedEntity - Mambu entity for which the custom field value is deleted. Example: MambuEntity.LOAN_TRANSACTOION

ownedEntityId - the entity id or encoded key for the owned entity (e.g transaction id)

customFieldValue - custom field value to be updated

Returns:

true if updated successfully

Throws:

MambuApiException

addGroupedFields

public boolean addGroupedFields(MambuEntityType parentEntity,
                                java.lang.String parentEntityId,
                                java.util.List<com.mambu.core.shared.model.CustomFieldValue> customFieldValues)
                         throws MambuApiException

Add new grouped custom field values for an entity. See MBU-12228- As a Developer, I Need to Add Grouped Custom Fields via PATCH APIs

Parameters:

parentEntity - Mambu entity for which the custom field values are added. Example: MambuEntity.CLIENT, MambuEntity.BRANCH

parentEntityId - id or encoded key for the parent entity

customFieldValues - custom field value to be added. Must not be null. All custom field values must belong to the same Grouped custom field set

Returns:

true if updated successfully

Throws:

MambuApiException

updateGroupedFields

public boolean updateGroupedFields(MambuEntityType parentEntity,
                                   java.lang.String parentEntityId,
                                   java.util.List<com.mambu.core.shared.model.CustomFieldValue> customFieldValues)
                            throws MambuApiException

Update grouped custom field values for an entity. See MBU-12229- As a Developer, I need to Edit Multiple Grouped Custom Fields via PATCH APIs

Parameters:

parentEntity - Mambu entity for which the custom field values are added. Example: MambuEntity.CLIENT, MambuEntity.BRANCH

parentEntityId - id or encoded key for the parent entity

customFieldValues - custom field value to be added. Must not be null. All custom field values must belong to the same Grouped custom field set. customFieldSetGroupIndex must be present in each field

Returns:

true if updated successfully

Throws:

MambuApiException

getSupportedEntities

public static MambuEntityType[] getSupportedEntities()

Get Mambu Entities supporting Custom Field Value API

Returns:

supported entities

isSupported

public static boolean isSupported(MambuEntityType parentEntityType)

Is parent entity type supported by the Custom Field Value API

Parameters:

parentEntityType - Mambu Entity type

Returns:

true if supported

getCustomFieldType

public static com.mambu.core.shared.model.CustomFieldType getCustomFieldType(MambuEntityType mambuEntityType)

Get CustomFieldType for the corresponding MambuEntityType

Parameters:

mambuEntityType - Mambu Entity Type

Returns:

Custom Field Type

update

public boolean update(MambuEntityType parentEntity,
                      java.lang.String parentEntityId,
                      java.util.List<com.mambu.core.shared.model.CustomFieldValue> customFieldValues)
               throws MambuApiException

Update a list of custom fields

Parameters:

parentEntity - The parent Mambu entity for which the custom field values will be updated. Must not be null. Example: MambuEntity.CLIENT.

parentEntityId - The entity id or encoded key for the parent entity (e.g. client id). Must not be null.

customFieldValues - A list containing the custom fields values to be updated. Must not be null or empty. Existent custom field values will be updated. If the provided custom field value was not present before - it will be added. Existent custom field values not present in the request will remain unchanged (they will NOT be deleted)

Returns:

true if custom field values were updated successfully

Throws:

MambuApiException

getCustomFieldValue

public java.util.List<com.mambu.core.shared.model.CustomFieldValue> getCustomFieldValue(MambuEntityType parentEntity,
                                                                                        java.lang.String parentEntityId,
                                                                                        java.lang.String customFieldId)
                                                                                 throws MambuApiException

Gets a list of CustomFieldValue for the corresponding parent entity type, parent entity id and custom field id.

Parameters:

parentEntity - The parent entity type. Must not be null.

parentEntityId - The id of the parent entity. Must not be null.

customFieldId - The id of the custom field. Must not be null.

Returns:

a list of custom field values registered for the parent entity or empty list if there are no custom fields for the specified custom field id. Usually a single value is expected for standard custom fields and multiple values for grouped custom fields.

Throws:

MambuApiException

getCustomFieldValue

public java.util.List<com.mambu.core.shared.model.CustomFieldValue> getCustomFieldValue(MambuEntityType parentEntity,
                                                                                        java.lang.String parentEntityId,
                                                                                        MambuEntityType ownedEntity,
                                                                                        java.lang.String ownedEntityId,
                                                                                        java.lang.String customFieldId)
                                                                                 throws MambuApiException

Gets a list of CustomFieldValue for the corresponding parent entity type, parentEntityId, ownedEntity type, owned entity id and custom field id.

Parameters:

parentEntity - The parent entity type. Must not be null

parentEntityId - The id of the parent entity. Must not be null.

ownedEntity - The owned entity type. Must not be null.

ownedEntityId - The id of the owned entity. Must not be null.

customFieldId - The id of the custom field. Must not be null.

Returns:

a list of custom field values registered for the owned entity or empty list if there are no custom fields for the specified custom field id. Usually a single value is expected for standard custom fields and multiple values for grouped custom fields.

Throws:

MambuApiException