org.camunda.bpm.engine.rest

Interface VariableInstanceRestService

All Known Implementing Classes:

VariableInstanceRestServiceImpl

@Produces(value="application/json")
public interface VariableInstanceRestService

Author:

roman.smirnov

Field Summary

Fields

Modifier and Type	Field and Description
static String	PATH

Method Summary

Modifier and Type	Method and Description
VariableInstanceResource	getVariableInstance(String id)
List<VariableInstanceDto>	getVariableInstances(javax.ws.rs.core.UriInfo uriInfo, Integer firstResult, Integer maxResults, boolean deserializeObjectValues) Exposes the VariableInstanceQuery interface as a REST service.
CountResultDto	getVariableInstancesCount(javax.ws.rs.core.UriInfo uriInfo)
List<VariableInstanceDto>	queryVariableInstances(VariableInstanceQueryDto queryDto, Integer firstResult, Integer maxResults, boolean deserializeObjectValues) Expects the same parameters as VariableInstanceRestService#getVariableInstances(UriInfo, Integer, Integer) (as a JSON message body) and allows for any number of variable checks.
CountResultDto	queryVariableInstancesCount(VariableInstanceQueryDto queryDto)

Field Detail

PATH

static final String PATH

See Also:

Constant Field Values

Method Detail

getVariableInstance

@Path(value="/{id}")
VariableInstanceResource getVariableInstance(@PathParam(value="id")
                                                                  String id)

getVariableInstances

@GET
 @Produces(value="application/json")
List<VariableInstanceDto> getVariableInstances(@Context
                                                                                         javax.ws.rs.core.UriInfo uriInfo,
                                                                                         @QueryParam(value="firstResult")
                                                                                         Integer firstResult,
                                                                                         @QueryParam(value="maxResults")
                                                                                         Integer maxResults,
                                                                                         @QueryParam(value="deserializeValues") @DefaultValue(value="true")
                                                                                         boolean deserializeObjectValues)

Exposes the VariableInstanceQuery interface as a REST service.

Parameters:

uriInfo -

firstResult -

maxResults -

Returns:

queryVariableInstances

@POST
 @Consumes(value="application/json")
 @Produces(value="application/json")
List<VariableInstanceDto> queryVariableInstances(VariableInstanceQueryDto queryDto,
                                                                                                                                 @QueryParam(value="firstResult")
                                                                                                                                 Integer firstResult,
                                                                                                                                 @QueryParam(value="maxResults")
                                                                                                                                 Integer maxResults,
                                                                                                                                 @QueryParam(value="deserializeValues") @DefaultValue(value="true")
                                                                                                                                 boolean deserializeObjectValues)

Expects the same parameters as VariableInstanceRestService#getVariableInstances(UriInfo, Integer, Integer) (as a JSON message body) and allows for any number of variable checks.

Parameters:

queryDto -

firstResult -

maxResults -

Returns:

getVariableInstancesCount

@GET
 @Path(value="/count")
 @Produces(value="application/json")
CountResultDto getVariableInstancesCount(@Context
                                                                                                          javax.ws.rs.core.UriInfo uriInfo)

queryVariableInstancesCount

@POST
 @Path(value="/count")
 @Consumes(value="application/json")
 @Produces(value="application/json")
CountResultDto queryVariableInstancesCount(VariableInstanceQueryDto queryDto)