To simplify the integration of the Mifos X Platform a Java based Client API is to be implemented.

This first evolution will cover all functions needed for individual lending.

This API will wrap all necessary REST calls and provides Domain Objects and a clean Object Oriented Interface for an Implementor to integrate the Mifos X Platform seamlessly.

Retrofit and OkHttp should be used to implement thes REST-Service handling.

The design pattern should follow these rules:

All classes a consumer is faced with are Interfaces, Factories or Domain Objects.

All implementations are located in a sub package internal and should not be used by a consumer.

The following package pattern should be used through out all code:

• org.mifos.sdk

  • contains main interfaces, classes and exceptions

• org.mifos.sdk.internal

  • contains implementations for all interfaces

• org.mifos.sdk.module

  • contains all module specific interfaces (e.g. office, staff)

• org.mifos.sdk.module.domain

  • contains all module specific domain objects

• org.mifos.sdk.module.internal

  • contains all module specific implementations

For further details see attached UML diagram.

See the following sample code faced by a consumer:

Sample usage