Package org.apache.fineract.client.services

Interface SelfDividendApi

public interface SelfDividendApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<String>	createDividendDetail(Long productId)
retrofit2.Call<String>	createDividendDetail(Long productId, String body)
retrofit2.Call<String>	createDividendDetail(Long productId, String body, Map<String,String> headers)
retrofit2.Call<String>	createDividendDetail(Long productId, Map<String,String> headers)
retrofit2.Call<String>	deleteDividendDetail(Long productId, Long dividendId)
retrofit2.Call<String>	deleteDividendDetail(Long productId, Long dividendId, Map<String,String> headers)
retrofit2.Call<String>	retrieveAll39(Long productId, Integer offset, Integer limit, String orderBy, String sortOrder, Integer status)
retrofit2.Call<String>	retrieveAll39(Long productId, Integer offset, Integer limit, String orderBy, String sortOrder, Integer status, Map<String,String> headers)
retrofit2.Call<String>	retrieveDividendDetails(Long dividendId, Long productId, Integer offset, Integer limit, String orderBy, String sortOrder, String accountNo)
retrofit2.Call<String>	retrieveDividendDetails(Long dividendId, Long productId, Integer offset, Integer limit, String orderBy, String sortOrder, String accountNo, Map<String,String> headers)
retrofit2.Call<String>	updateDividendDetail(Long productId, Long dividendId, String command)
retrofit2.Call<String>	updateDividendDetail(Long productId, Long dividendId, String command, String body)
retrofit2.Call<String>	updateDividendDetail(Long productId, Long dividendId, String command, String body, Map<String,String> headers)
retrofit2.Call<String>	updateDividendDetail(Long productId, Long dividendId, String command, Map<String,String> headers)

Method Details

createDividendDetail

@Headers("Content-Type:application/json")
@POST("v1/shareproduct/{productId}/dividend")
retrofit2.Call<String> createDividendDetail(@Path("productId")
 Long productId,
 @Body
 String body)

Parameters:

productId - (required)

body - (optional)

Returns:

Call<String>

deleteDividendDetail

@DELETE("v1/shareproduct/{productId}/dividend/{dividendId}")
retrofit2.Call<String> deleteDividendDetail(@Path("productId")
 Long productId,
 @Path("dividendId")
 Long dividendId)

Parameters:

productId - (required)

dividendId - (required)

Returns:

Call<String>

retrieveAll39

@GET("v1/shareproduct/{productId}/dividend")
retrofit2.Call<String> retrieveAll39(@Path("productId")
 Long productId,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder,
 @Query("status")
 Integer status)

Parameters:

productId - (required)

offset - (optional)

limit - (optional)

orderBy - (optional)

sortOrder - (optional)

status - (optional)

Returns:

Call<String>

retrieveDividendDetails

@GET("v1/shareproduct/{productId}/dividend/{dividendId}")
retrofit2.Call<String> retrieveDividendDetails(@Path("dividendId")
 Long dividendId,
 @Path("productId")
 Long productId,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder,
 @Query("accountNo")
 String accountNo)

Parameters:

dividendId - (required)

productId - (required)

offset - (optional)

limit - (optional)

orderBy - (optional)

sortOrder - (optional)

accountNo - (optional)

Returns:

Call<String>

updateDividendDetail

@Headers("Content-Type:application/json")
@PUT("v1/shareproduct/{productId}/dividend/{dividendId}")
retrofit2.Call<String> updateDividendDetail(@Path("productId")
 Long productId,
 @Path("dividendId")
 Long dividendId,
 @Query("command")
 String command,
 @Body
 String body)

Parameters:

productId - (required)

dividendId - (required)

command - (optional)

body - (optional)

Returns:

Call<String>

createDividendDetail

@Headers("Content-Type:application/json")
@POST("v1/shareproduct/{productId}/dividend")
retrofit2.Call<String> createDividendDetail(@Path("productId")
 Long productId)

Parameters:

productId - (required)

body - (optional)

Returns:

Call<String>

updateDividendDetail

@Headers("Content-Type:application/json")
@PUT("v1/shareproduct/{productId}/dividend/{dividendId}")
retrofit2.Call<String> updateDividendDetail(@Path("productId")
 Long productId,
 @Path("dividendId")
 Long dividendId,
 @Query("command")
 String command)

Parameters:

productId - (required)

dividendId - (required)

command - (optional)

body - (optional)

Returns:

Call<String>

createDividendDetail

@Headers("Content-Type:application/json")
@POST("v1/shareproduct/{productId}/dividend")
retrofit2.Call<String> createDividendDetail(@Path("productId")
 Long productId,
 @Body
 String body,
 @HeaderMap
 Map<String,String> headers)

Parameters:

productId - (required)

body - (optional)

Returns:

Call<String>

deleteDividendDetail

@DELETE("v1/shareproduct/{productId}/dividend/{dividendId}")
retrofit2.Call<String> deleteDividendDetail(@Path("productId")
 Long productId,
 @Path("dividendId")
 Long dividendId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

productId - (required)

dividendId - (required)

Returns:

Call<String>

retrieveAll39

@GET("v1/shareproduct/{productId}/dividend")
retrofit2.Call<String> retrieveAll39(@Path("productId")
 Long productId,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder,
 @Query("status")
 Integer status,
 @HeaderMap
 Map<String,String> headers)

Parameters:

productId - (required)

offset - (optional)

limit - (optional)

orderBy - (optional)

sortOrder - (optional)

status - (optional)

Returns:

Call<String>

retrieveDividendDetails

@GET("v1/shareproduct/{productId}/dividend/{dividendId}")
retrofit2.Call<String> retrieveDividendDetails(@Path("dividendId")
 Long dividendId,
 @Path("productId")
 Long productId,
 @Query("offset")
 Integer offset,
 @Query("limit")
 Integer limit,
 @Query("orderBy")
 String orderBy,
 @Query("sortOrder")
 String sortOrder,
 @Query("accountNo")
 String accountNo,
 @HeaderMap
 Map<String,String> headers)

Parameters:

dividendId - (required)

productId - (required)

offset - (optional)

limit - (optional)

orderBy - (optional)

sortOrder - (optional)

accountNo - (optional)

Returns:

Call<String>

updateDividendDetail

@Headers("Content-Type:application/json")
@PUT("v1/shareproduct/{productId}/dividend/{dividendId}")
retrofit2.Call<String> updateDividendDetail(@Path("productId")
 Long productId,
 @Path("dividendId")
 Long dividendId,
 @Query("command")
 String command,
 @Body
 String body,
 @HeaderMap
 Map<String,String> headers)

Parameters:

productId - (required)

dividendId - (required)

command - (optional)

body - (optional)

Returns:

Call<String>

createDividendDetail

@Headers("Content-Type:application/json")
@POST("v1/shareproduct/{productId}/dividend")
retrofit2.Call<String> createDividendDetail(@Path("productId")
 Long productId,
 @HeaderMap
 Map<String,String> headers)

Parameters:

productId - (required)

body - (optional)

Returns:

Call<String>

updateDividendDetail

@Headers("Content-Type:application/json")
@PUT("v1/shareproduct/{productId}/dividend/{dividendId}")
retrofit2.Call<String> updateDividendDetail(@Path("productId")
 Long productId,
 @Path("dividendId")
 Long dividendId,
 @Query("command")
 String command,
 @HeaderMap
 Map<String,String> headers)

Parameters:

productId - (required)

dividendId - (required)

command - (optional)

body - (optional)

Returns:

Call<String>