Package org.neotropic.kuwaiba.northbound.rest.bem

Interface ContactRestOpenApi

All Known Implementing Classes:

ContactRestController

@RequestMapping("/v2.1.1/contact-manager/")
public interface ContactRestOpenApi

Swagger documentation for contact manager.

Author:

Mauricio Ruiz Beltrán <mauricio.ruiz@kuwaiba.org>

Field Summary

Fields

Modifier and Type	Field	Description
static String	PATH	Path that includes the Kuwaiba version and core

Method Summary

Modifier and Type	Method	Description
String	createContact(@NotNull @Valid String contactClassName, @NotNull @Valid String customerClassName, @NotNull @Valid String customerId, @NotNull @Valid String userName, @NotNull @Valid String sessionId)
void	deleteContact(@NotNull @Valid String contactClassName, @NotNull @Valid String contactId, @NotNull @Valid String userName, @NotNull @Valid String sessionId)
Contact	getContact(@NotNull @Valid String contactClassName, @NotNull @Valid String contactId, @NotNull @Valid String sessionId)
List<BusinessObjectLight>	getContactResources(@NotNull @Valid String contactClassName, @NotNull @Valid String contactId, @NotNull @Valid String sessionId)
List<Contact>	getContacts(@javax.validation.constraints.NotNull,@javax.validation.Valid int page, @javax.validation.constraints.NotNull,@javax.validation.Valid int limit, @Valid HashMap<String,Object> filters, @NotNull @Valid String sessionId)
List<Contact>	getContactsForCustomer(@NotNull @Valid String customerClassName, @NotNull @Valid String customerId, @NotNull @Valid String sessionId)
void	relateObjectToContact(@NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @NotNull @Valid String contactClassName, @NotNull @Valid String contactId, @NotNull @Valid String userName, @NotNull @Valid String sessionId)
void	releaseObjectFromContact(@NotNull @Valid String objectClassName, @NotNull @Valid String objectId, @NotNull @Valid String contactClassName, @NotNull @Valid String contactId, @NotNull @Valid String userName, @NotNull @Valid String sessionId)
List<Contact>	searchForContacts(@NotNull @Valid String searchString, @javax.validation.constraints.NotNull,@javax.validation.Valid int maxResults, @NotNull @Valid String sessionId)
void	updateContact(@NotNull @Valid String contactClassName, @NotNull @Valid String contactId, @Valid List<StringPair> properties, @NotNull @Valid String userName, @NotNull @Valid String sessionId)

Field Detail

PATH

static final String PATH

Path that includes the Kuwaiba version and core

See Also:

Constant Field Values

Method Detail

createContact

@RequestMapping(method=POST,
                value="createContact/{contactClassName}/{customerClassName}/{customerId}/{userName}/{sessionId}",
                produces="application/json")
String createContact(@NotNull @Valid @PathVariable(value="contactClassName",required=true)
                     @NotNull @Valid String contactClassName,
                     @NotNull @Valid @PathVariable(value="customerClassName",required=true)
                     @NotNull @Valid String customerClassName,
                     @NotNull @Valid @PathVariable(value="customerId",required=true)
                     @NotNull @Valid String customerId,
                     @NotNull @Valid @PathVariable(value="userName",required=true)
                     @NotNull @Valid String userName,
                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                     @NotNull @Valid String sessionId)

updateContact

@RequestMapping(method=PUT,
                value="updateContact/{contactClassName}/{contactId}/{userName}/{sessionId}",
                produces="application/json")
void updateContact(@NotNull @Valid @PathVariable(value="contactClassName",required=true)
                   @NotNull @Valid String contactClassName,
                   @NotNull @Valid @PathVariable(value="contactId",required=true)
                   @NotNull @Valid String contactId,
                   @Valid @RequestBody
                   @Valid List<StringPair> properties,
                   @NotNull @Valid @PathVariable(value="userName",required=true)
                   @NotNull @Valid String userName,
                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                   @NotNull @Valid String sessionId)

deleteContact

@RequestMapping(method=DELETE,
                value="deleteContact/{contactClassName}/{contactId}/{userName}/{sessionId}",
                produces="application/json")
void deleteContact(@NotNull @Valid @PathVariable(value="contactClassName",required=true)
                   @NotNull @Valid String contactClassName,
                   @NotNull @Valid @PathVariable(value="contactId",required=true)
                   @NotNull @Valid String contactId,
                   @NotNull @Valid @PathVariable(value="userName",required=true)
                   @NotNull @Valid String userName,
                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                   @NotNull @Valid String sessionId)

getContact

@RequestMapping(method=GET,
                value="getContact/{contactClassName}/{contactId}/{sessionId}",
                produces="application/json")
Contact getContact(@NotNull @Valid @PathVariable(value="contactClassName",required=true)
                   @NotNull @Valid String contactClassName,
                   @NotNull @Valid @PathVariable(value="contactId",required=true)
                   @NotNull @Valid String contactId,
                   @NotNull @Valid @PathVariable(value="sessionId",required=true)
                   @NotNull @Valid String sessionId)

getContactsForCustomer

@RequestMapping(method=GET,
                value="getContactsForCustomer/{customerClassName}/{customerId}/{sessionId}",
                produces="application/json")
List<Contact> getContactsForCustomer(@NotNull @Valid @PathVariable(value="customerClassName",required=true)
                                     @NotNull @Valid String customerClassName,
                                     @NotNull @Valid @PathVariable(value="customerId",required=true)
                                     @NotNull @Valid String customerId,
                                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                     @NotNull @Valid String sessionId)

searchForContacts

@RequestMapping(method=GET,
                value="searchForContacts/{searchString}/{maxResults}/{sessionId}",
                produces="application/json")
List<Contact> searchForContacts(@NotNull @Valid @PathVariable(value="searchString",required=true)
                                @NotNull @Valid String searchString,
                                @NotNull @Valid @PathVariable(value="maxResults",required=true)
                                @javax.validation.constraints.NotNull,@javax.validation.Valid int maxResults,
                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                @NotNull @Valid String sessionId)

getContacts

List<Contact> getContacts(@NotNull @Valid @PathVariable(value="page",required=true)
                          @javax.validation.constraints.NotNull,@javax.validation.Valid int page,
                          @NotNull @Valid @PathVariable(value="limit",required=true)
                          @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                          @Valid @RequestBody
                          @Valid HashMap<String,Object> filters,
                          @NotNull @Valid @PathVariable(value="sessionId",required=true)
                          @NotNull @Valid String sessionId)

relateObjectToContact

@RequestMapping(method=PUT,
                value="relateObjectToContact/{objectClassName}/{objectId}/{contactClassName}/{contactId}/{userName}/{sessionId}",
                produces="application/json")
void relateObjectToContact(@NotNull @Valid @PathVariable(value="objectClassName",required=true)
                           @NotNull @Valid String objectClassName,
                           @NotNull @Valid @PathVariable(value="objectId",required=true)
                           @NotNull @Valid String objectId,
                           @NotNull @Valid @PathVariable(value="contactClassName",required=true)
                           @NotNull @Valid String contactClassName,
                           @NotNull @Valid @PathVariable(value="contactId",required=true)
                           @NotNull @Valid String contactId,
                           @NotNull @Valid @PathVariable(value="userName",required=true)
                           @NotNull @Valid String userName,
                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)

releaseObjectFromContact

@RequestMapping(method=PUT,
                value="releaseObjectFromContact/{objectClassName}/{objectId}/{contactClassName}/{contactId}/{userName}/{sessionId}",
                produces="application/json")
void releaseObjectFromContact(@NotNull @Valid @PathVariable(value="objectClassName",required=true)
                              @NotNull @Valid String objectClassName,
                              @NotNull @Valid @PathVariable(value="objectId",required=true)
                              @NotNull @Valid String objectId,
                              @NotNull @Valid @PathVariable(value="contactClassName",required=true)
                              @NotNull @Valid String contactClassName,
                              @NotNull @Valid @PathVariable(value="contactId",required=true)
                              @NotNull @Valid String contactId,
                              @NotNull @Valid @PathVariable(value="userName",required=true)
                              @NotNull @Valid String userName,
                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                              @NotNull @Valid String sessionId)

getContactResources

@RequestMapping(method=GET,
                value="getContactResources/{contactClassName}/{contactId}/{sessionId}",
                produces="application/json")
List<BusinessObjectLight> getContactResources(@NotNull @Valid @PathVariable(value="contactClassName",required=true)
                                              @NotNull @Valid String contactClassName,
                                              @NotNull @Valid @PathVariable(value="contactId",required=true)
                                              @NotNull @Valid String contactId,
                                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                              @NotNull @Valid String sessionId)