Package org.camunda.bpm.engine.rest.sub.runtime

Interface FilterResource

All Known Implementing Classes:

FilterResourceImpl

public interface FilterResource

Author:

Sebastian Menski

Method Summary

Modifier and Type	Method	Description
ResourceOptionsDto	availableOperations(jakarta.ws.rs.core.UriInfo context)
void	deleteFilter()
CountResultDto	executeCount()
Object	executeList(jakarta.ws.rs.core.Request request, Integer firstResult, Integer maxResults)
Object	executeSingleResult(jakarta.ws.rs.core.Request request)
FilterDto	getFilter(Boolean itemCount)
CountResultDto	queryCount(String extendingQuery)
Object	queryList(jakarta.ws.rs.core.Request request, String extendingQuery, Integer firstResult, Integer maxResults)
Object	querySingleResult(jakarta.ws.rs.core.Request request, String extendingQuery)
void	updateFilter(FilterDto filterDto)

Method Details

getFilter

@GET
@Produces("application/json")
FilterDto getFilter(@QueryParam("itemCount")
 Boolean itemCount)

deleteFilter

@DELETE
void deleteFilter()

updateFilter

@PUT
@Consumes("application/json")
void updateFilter(FilterDto filterDto)

executeSingleResult

@GET
@Path("/singleResult")
@Produces({"application/json","application/hal+json"})
Object executeSingleResult(@Context
 jakarta.ws.rs.core.Request request)

querySingleResult

@POST
@Path("/singleResult")
@Produces({"application/json","application/hal+json"})
@Consumes("application/json")
Object querySingleResult(@Context
 jakarta.ws.rs.core.Request request,
 String extendingQuery)

executeList

@GET
@Path("/list")
@Produces({"application/json","application/hal+json"})
Object executeList(@Context
 jakarta.ws.rs.core.Request request,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 Integer maxResults)

queryList

@POST
@Path("/list")
@Produces({"application/json","application/hal+json"})
@Consumes("application/json")
Object queryList(@Context
 jakarta.ws.rs.core.Request request,
 String extendingQuery,
 @QueryParam("firstResult")
 Integer firstResult,
 @QueryParam("maxResults")
 Integer maxResults)

executeCount

@GET
@Path("/count")
@Produces("application/json")
CountResultDto executeCount()

queryCount

@POST
@Path("/count")
@Produces("application/json")
@Consumes("application/json")
CountResultDto queryCount(String extendingQuery)

availableOperations

@OPTIONS
@Produces("application/json")
ResourceOptionsDto availableOperations(@Context
 jakarta.ws.rs.core.UriInfo context)