Package org.apache.fineract.portfolio.calendar.api

Class CalendarsApiResource

java.lang.Object

org.apache.fineract.portfolio.calendar.api.CalendarsApiResource

@Path("/v1/{entityType}/{entityId}/calendars")
@Component
public class CalendarsApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
CalendarsApiResource()

Method Summary

Modifier and Type	Method	Description
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	createCalendar(String entityType, Long entityId, org.apache.fineract.portfolio.calendar.data.request.CalendarRequest calendarRequest)
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	deleteCalendar(String entityType, Long entityId, Long calendarId)
org.apache.fineract.portfolio.calendar.data.CalendarData	retrieveCalendar(Long calendarId, String entityType, Long entityId, jakarta.ws.rs.core.UriInfo uriInfo)
List<org.apache.fineract.portfolio.calendar.data.CalendarData>	retrieveCalendarsByEntity(String entityType, Long entityId, jakarta.ws.rs.core.UriInfo uriInfo, String calendarType)
org.apache.fineract.portfolio.calendar.data.CalendarData	retrieveNewCalendarDetails(jakarta.ws.rs.core.UriInfo uriInfo, String entityType, Long entityId)
org.apache.fineract.infrastructure.core.data.CommandProcessingResult	updateCalendar(String entityType, Long entityId, Long calendarId, String jsonRequestBody)

Methods inherited from class java.lang.Object

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

Constructor Details

CalendarsApiResource

public CalendarsApiResource()

Method Details

retrieveCalendar

@GET
@Path("{calendarId}")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.portfolio.calendar.data.CalendarData retrieveCalendar(@PathParam("calendarId")
 Long calendarId,
 @PathParam("entityType")
 String entityType,
 @PathParam("entityId")
 Long entityId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveCalendarsByEntity

@GET
@Consumes("application/json")
@Produces("application/json")
public List<org.apache.fineract.portfolio.calendar.data.CalendarData> retrieveCalendarsByEntity(@PathParam("entityType")
 String entityType,
 @PathParam("entityId")
 Long entityId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @DefaultValue("all") @QueryParam("calendarType")
 String calendarType)

Parameters:

entityType -

entityId -

uriInfo -

calendarType -

Returns:

retrieveNewCalendarDetails

@GET
@Path("template")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.portfolio.calendar.data.CalendarData retrieveNewCalendarDetails(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("entityType")
 String entityType,
 @PathParam("entityId")
 Long entityId)

createCalendar

@POST
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult createCalendar(@PathParam("entityType")
 String entityType,
 @PathParam("entityId")
 Long entityId,
 org.apache.fineract.portfolio.calendar.data.request.CalendarRequest calendarRequest)

updateCalendar

@PUT
@Path("{calendarId}")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult updateCalendar(@PathParam("entityType")
 String entityType,
 @PathParam("entityId")
 Long entityId,
 @PathParam("calendarId")
 Long calendarId,
 String jsonRequestBody)

deleteCalendar

@DELETE
@Path("{calendarId}")
@Consumes("application/json")
@Produces("application/json")
public org.apache.fineract.infrastructure.core.data.CommandProcessingResult deleteCalendar(@PathParam("entityType")
 String entityType,
 @PathParam("entityId")
 Long entityId,
 @PathParam("calendarId")
 Long calendarId)