org.optaweb.employeerostering.shared.contract

Interface ContractRestService

@Path(value="/tenant/{tenantId}/contract")
 @Produces(value="application/json")
 @Consumes(value="application/json")
 @GenRestBuilder
public interface ContractRestService

Method Summary

Modifier and Type	Method and Description
Contract	addContract(Integer tenantId, Contract contract)
Contract	getContract(Integer tenantId, Long id)
List<Contract>	getContractList(Integer tenantId)
Boolean	removeContract(Integer tenantId, Long id)
Contract	updateContract(Integer tenantId, Contract contract)

Method Detail

getContractList

@GET
 @Path(value="/")
List<Contract> getContractList(@PathParam(value="tenantId")
                                                      Integer tenantId)

getContract

@GET
 @Path(value="/{id}")
Contract getContract(@PathParam(value="tenantId")
                                                Integer tenantId,
                                                @PathParam(value="id")
                                                Long id)

Parameters:

id - never null

Returns:

never null, the id

addContract

@POST
 @Path(value="/add")
Contract addContract(@PathParam(value="tenantId")
                                                Integer tenantId,
                                                Contract contract)

Parameters:

contract - never null

Returns:

never null, with a AbstractPersistable.getId() that is never null

updateContract

@POST
 @Path(value="/update")
Contract updateContract(@PathParam(value="tenantId")
                                                      Integer tenantId,
                                                      Contract contract)

Parameters:

contract - never null

Returns:

never null, with an updated AbstractPersistable.getVersion()

removeContract

@DELETE
 @Path(value="/{id}")
Boolean removeContract(@PathParam(value="tenantId")
                                                     Integer tenantId,
                                                     @PathParam(value="id")
                                                     Long id)

Parameters:

id - never null

Returns:

true if the contract was successfully removed, false otherwise