Package de.hybris.platform.agreementtmfwebservices.v2.api

Interface AgreementApi

All Known Implementing Classes:

AgrAgreementsController

public interface AgreementApi

Interface handling operations for Agreement.

Since:

2302

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<Agreement>	createAgreement(@Valid Agreement agreement)
org.springframework.http.ResponseEntity<Void>	deleteAgreement(String id)
org.springframework.http.ResponseEntity<List<Agreement>>	listAgreement(@Valid String fields, @Valid Integer offset, @Valid Integer limit, @Valid String status)
org.springframework.http.ResponseEntity<Agreement>	patchAgreement(String id, @Valid Agreement agreement)
org.springframework.http.ResponseEntity<Agreement>	retrieveAgreement(String id, @Valid String fields)

Method Details

createAgreement

@RequestMapping(value="/agreement",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=POST)
org.springframework.http.ResponseEntity<Agreement> createAgreement(@Valid @RequestBody
 @Valid Agreement agreement)

deleteAgreement

@RequestMapping(value="/agreement/{id}",
                produces="application/json;charset=utf-8",
                method=DELETE)
org.springframework.http.ResponseEntity<Void> deleteAgreement(@PathVariable("id")
 String id)

listAgreement

@RequestMapping(value="/agreement",
                produces="application/json;charset=utf-8",
                method=GET)
org.springframework.http.ResponseEntity<List<Agreement>> listAgreement(@Valid @RequestParam(value="fields",required=false)
 @Valid String fields,
 @Valid @RequestParam(value="offset",required=false)
 @Valid Integer offset,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit,
 @Valid @RequestParam(value="status",required=false)
 @Valid String status)

patchAgreement

@RequestMapping(value="/agreement/{id}",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=PATCH)
org.springframework.http.ResponseEntity<Agreement> patchAgreement(@PathVariable("id")
 String id,
 @Valid @RequestBody
 @Valid Agreement agreement)

retrieveAgreement

@RequestMapping(value="/agreement/{id}",
                produces="application/json;charset=utf-8",
                method=GET)
org.springframework.http.ResponseEntity<Agreement> retrieveAgreement(@PathVariable("id")
 String id,
 @Valid @RequestParam(value="fields",required=false)
 @Valid String fields)