de.hybris.platform.couponwebservices.controllers

Class CouponservicesController

java.lang.Object

de.hybris.platform.couponwebservices.controllers.CouponservicesController

public class CouponservicesController
extends java.lang.Object

Couponservices Controller

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_CURRENT_PAGE
static java.lang.String	DEFAULT_FIELD_SET
static java.lang.String	DEFAULT_PAGE_SIZE
static java.lang.String	DEFAULT_SORT
static java.lang.String	URL_V2

Constructor Summary

Constructors

Constructor and Description
CouponservicesController()

Method Summary

Modifier and Type	Method and Description
protected CouponGeneratedCodeWsDTO	createCouponGeneratedCodeWsDTO(java.lang.String couponId, MediaModel mediaModel)
MultiCodeCouponWsDTO	createMultiCodeCouponWsDTO(MultiCodeCouponWsDTO couponWsDTO) Method to create a new multi-code coupon object given in POST body parameter Example : URL : http://localhost:9001/couponwebservices/couponservices/multicodecoupon Method : POST Header : Content-Type=application/json POST body parameter :{ "couponId" : "COUPON123", "name":"test_multi_coupon", }
SingleCodeCouponWsDTO	createSingleCodeCouponWsDTO(SingleCodeCouponWsDTO couponWsDTO) Method to create a new single-code coupon object given in POST body parameter Example : URL : http://localhost:9001/couponwebservices/couponservices/singlecodecoupon Method : POST Header : Content-Type=application/json POST body parameter :{ "couponId" : "TEST_COUPON1", "name":"test_coupon", "maxRedemptionsPerCustomer":"2", "maxTotalRedemptions":"10" }
<any>	generateCouponCodes(java.lang.String couponId, int batchsize) Generate multi-code coupon codes
CodeGenerationConfigurationWsDTO	getCodeGenerationConfiguration(java.lang.String codeGenerationConfigurationName, java.lang.String fields) Request to get a single-code coupon with given couponId
CodeGenerationConfigurationsSearchPageWsDTO	getCodeGenerationConfigurations(java.lang.String fields, int currentPage, int pageSize, java.lang.String sort) Deprecated. since 6.6 please use next api version /couponservices/v2/codegenerationconfiguration/list defined in CouponservicesV2Controller.getCodeGenerationConfigurations(java.lang.String, int, int, java.lang.String)
protected CodeGenerationConfigurationWsFacade	getCodeGenerationConfigurationWsFacade()
protected CouponCodeGenerationWsFacade	getCouponCodeGenerationWsFacade()
protected CouponRedemptionWsFacade	getCouponRedemptionWsFacade()
protected Validator	getCouponStatusWsDTOValidator()
protected DataMapper	getDataMapper()
MultiCodeCouponWsDTO	getMultiCodeCoupon(java.lang.String couponId, java.lang.String fields) Request to get a multi-code coupon with given couponId
MultiCodeCouponsSearchPageWsDTO	getMultiCodeCoupons(java.lang.String fields, int currentPage, int pageSize, java.lang.String sort) Deprecated. since 6.6 please use next api version /couponservices/v2/multicodecoupon/list defined in CouponservicesV2Controller.getMultiCodeCoupons(java.lang.String, int, int, java.lang.String)
protected Validator	getMultiCodeCouponWsDTOValidator()
protected CouponWsFacades<MultiCodeCouponWsDTO>	getMultiCodeCouponWsFacades()
SingleCodeCouponWsDTO	getSingleCodeCoupon(java.lang.String couponId, java.lang.String fields) Request to get a single-code coupon with given couponId
CouponRedemptionWsDTO	getSingleCodeCouponRedemption(java.lang.String couponId, java.lang.String customerId, java.lang.String fields) Request to get a redemption status for a single-code coupon with given couponId
SingleCodeCouponsSearchPageWsDTO	getSingleCodeCoupons(java.lang.String fields, int currentPage, int pageSize, java.lang.String sort) Deprecated. since 6.6 please use next api version /couponservices/v2/singlecodecoupon/list defined in CouponservicesV2Controller.getSingleCodeCoupons(java.lang.String, int, int, java.lang.String)
protected Validator	getSingleCodeCouponWsDTOValidator()
protected CouponWsFacades<SingleCodeCouponWsDTO>	getSingleCodeCouponWsFacades()
void	updateMultiCodeCouponWsDTO(MultiCodeCouponWsDTO couponWsDTO) Method to update a multi-code coupon object given in PUT body parameter Example : URL : http://localhost:9001/couponwebservices/couponservices/multicodecoupon/update Method : PUT Header : Content-Type=application/json PUT body parameter :{ "couponId" : "TEST_COUPON1", "name":"test_coupon" }
void	updateMultiCodeStatusCouponWsDTO(CouponStatusWsDTO couponStatusWsDTO) Method to update a multi-code coupon status Example : URL : http://localhost:9001/couponwebservices/couponservices/multicodecoupon/update/status Method : PUT PUT body parameters
void	updateSingleCodeCouponWsDTO(SingleCodeCouponWsDTO couponWsDTO) Method to update a single-code coupon object given in PUT body parameter Example : URL : http://localhost:9001/couponwebservices/couponservices/singlecodecoupon/update Method : PUT Header : Content-Type=application/json PUT body parameter :{ "couponId" : "TEST_COUPON1", "name":"test_coupon", "maxRedemptionsPerCustomer":"2", "maxTotalRedemptions":"10" }
void	updateSingleCodeStatusCouponWsDTO(CouponStatusWsDTO couponStatusWsDTO) Method to update a single-code coupon status Example : URL : http://localhost:9001/couponwebservices/couponservices/singlecodecoupon/update/status Method : PUT PUT body parameters
protected void	validate(java.lang.Object object, java.lang.String objectName, Validator validator) Validates the object by using the passed validator
CouponValidationResponseWsDTO	validateMultiCodeCoupon(java.lang.String couponCode, java.lang.String fields) Request to validate a multi-code coupon with given couponId
CouponValidationResponseWsDTO	validateSingleCodeCoupon(java.lang.String couponId, java.lang.String customerId, java.lang.String fields) Request to validate a single-code coupon with given couponId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_FIELD_SET

public static final java.lang.String DEFAULT_FIELD_SET

See Also:

Constant Field Values

DEFAULT_CURRENT_PAGE

public static final java.lang.String DEFAULT_CURRENT_PAGE

See Also:

Constant Field Values

DEFAULT_PAGE_SIZE

public static final java.lang.String DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

DEFAULT_SORT

public static final java.lang.String DEFAULT_SORT

See Also:

Constant Field Values

URL_V2

public static final java.lang.String URL_V2

See Also:

Constant Field Values

Constructor Detail

CouponservicesController

public CouponservicesController()

Method Detail

getSingleCodeCoupons

@Deprecated
public SingleCodeCouponsSearchPageWsDTO getSingleCodeCoupons(java.lang.String fields,
                                                                         int currentPage,
                                                                         int pageSize,
                                                                         java.lang.String sort)

Deprecated. since 6.6 please use next api version /couponservices/v2/singlecodecoupon/list defined in CouponservicesV2Controller.getSingleCodeCoupons(java.lang.String, int, int, java.lang.String)

Request to get all single-code coupons registered in the system

Parameters:

fields - defaulted to DEFAULT but can be FULL or BASIC

currentPage - number of the current page

pageSize - number of items in a page

sort - sorting the results ascending or descending

Returns:

the list of single-code coupons

getMultiCodeCoupons

@Deprecated
public MultiCodeCouponsSearchPageWsDTO getMultiCodeCoupons(java.lang.String fields,
                                                                       int currentPage,
                                                                       int pageSize,
                                                                       java.lang.String sort)

Deprecated. since 6.6 please use next api version /couponservices/v2/multicodecoupon/list defined in CouponservicesV2Controller.getMultiCodeCoupons(java.lang.String, int, int, java.lang.String)

Request to get all multi-code coupons registered in the system

Parameters:

fields - defaulted to DEFAULT but can be FULL or BASIC

currentPage - number of the current page

pageSize - number of items in a page

sort - sorting the results ascending or descending

Returns:

the list of multi-code coupons

createSingleCodeCouponWsDTO

public SingleCodeCouponWsDTO createSingleCodeCouponWsDTO(SingleCodeCouponWsDTO couponWsDTO)

Method to create a new single-code coupon object given in POST body parameter
Example :
URL : http://localhost:9001/couponwebservices/couponservices/singlecodecoupon
Method : POST
Header : Content-Type=application/json
POST body parameter :{ "couponId" : "TEST_COUPON1", "name":"test_coupon", "maxRedemptionsPerCustomer":"2", "maxTotalRedemptions":"10" }

Parameters:

couponWsDTO - - Request body parameter (DTO in xml or json format)

Returns:

- instance of SingleCodeCouponWsDTO, that was saved in the system

updateSingleCodeStatusCouponWsDTO

public void updateSingleCodeStatusCouponWsDTO(CouponStatusWsDTO couponStatusWsDTO)

Method to update a single-code coupon status
Example :
URL : http://localhost:9001/couponwebservices/couponservices/singlecodecoupon/update/status
Method : PUT
PUT body parameters

Parameters:

couponStatusWsDTO - - request object containing couponId and active attributes

updateMultiCodeStatusCouponWsDTO

public void updateMultiCodeStatusCouponWsDTO(CouponStatusWsDTO couponStatusWsDTO)

Method to update a multi-code coupon status
Example :
URL : http://localhost:9001/couponwebservices/couponservices/multicodecoupon/update/status
Method : PUT
PUT body parameters

Parameters:

couponStatusWsDTO - - request object containing couponId and active attributes

updateSingleCodeCouponWsDTO

public void updateSingleCodeCouponWsDTO(SingleCodeCouponWsDTO couponWsDTO)

Method to update a single-code coupon object given in PUT body parameter
Example :
URL : http://localhost:9001/couponwebservices/couponservices/singlecodecoupon/update
Method : PUT
Header : Content-Type=application/json
PUT body parameter :{ "couponId" : "TEST_COUPON1", "name":"test_coupon", "maxRedemptionsPerCustomer":"2", "maxTotalRedemptions":"10" }

Parameters:

couponWsDTO - - Request body parameter (DTO in xml or json format)

updateMultiCodeCouponWsDTO

public void updateMultiCodeCouponWsDTO(MultiCodeCouponWsDTO couponWsDTO)

Method to update a multi-code coupon object given in PUT body parameter
Example :
URL : http://localhost:9001/couponwebservices/couponservices/multicodecoupon/update
Method : PUT
Header : Content-Type=application/json
PUT body parameter :{ "couponId" : "TEST_COUPON1", "name":"test_coupon" }

Parameters:

couponWsDTO - - Request body parameter (DTO in xml or json format)

createMultiCodeCouponWsDTO

public MultiCodeCouponWsDTO createMultiCodeCouponWsDTO(MultiCodeCouponWsDTO couponWsDTO)

Method to create a new multi-code coupon object given in POST body parameter
Example :
URL : http://localhost:9001/couponwebservices/couponservices/multicodecoupon
Method : POST
Header : Content-Type=application/json
POST body parameter :{ "couponId" : "COUPON123", "name":"test_multi_coupon", }

Parameters:

couponWsDTO - - Request body parameter (DTO in xml or json format)

Returns:

- instance of MultiCodeCouponWsDTO, that was saved in the system

getSingleCodeCoupon

public SingleCodeCouponWsDTO getSingleCodeCoupon(java.lang.String couponId,
                                                 java.lang.String fields)

Request to get a single-code coupon with given couponId

Parameters:

couponId - the couponId of the requested coupon

fields - defaulted to DEFAULT but can be FULL or BASIC

Returns:

instance of SingleCodeCouponWsDTO, corresponding to couponId

validateSingleCodeCoupon

public CouponValidationResponseWsDTO validateSingleCodeCoupon(java.lang.String couponId,
                                                              java.lang.String customerId,
                                                              java.lang.String fields)

Request to validate a single-code coupon with given couponId

Parameters:

couponId - the couponId of the requested coupon

customerId - the user id

fields - defaulted to DEFAULT but can be FULL or BASIC

Returns:

instance of SingleCodeCouponWsDTO, corresponding to couponId

getMultiCodeCoupon

public MultiCodeCouponWsDTO getMultiCodeCoupon(java.lang.String couponId,
                                               java.lang.String fields)

Request to get a multi-code coupon with given couponId

Parameters:

couponId - the couponId of the requested coupon

fields - defaulted to DEFAULT but can be FULL or BASIC

Returns:

instance of MultiCodeCouponWsDTO, corresponding to couponId

createCouponGeneratedCodeWsDTO

protected CouponGeneratedCodeWsDTO createCouponGeneratedCodeWsDTO(java.lang.String couponId,
                                                                  MediaModel mediaModel)

validateMultiCodeCoupon

public CouponValidationResponseWsDTO validateMultiCodeCoupon(java.lang.String couponCode,
                                                             java.lang.String fields)

Request to validate a multi-code coupon with given couponId

Parameters:

couponCode - the couponCode of the requested coupon

fields - defaulted to DEFAULT but can be FULL or BASIC

Returns:

instance of CouponValidationResponseWsDTO, corresponding to couponCode

generateCouponCodes

public <any> generateCouponCodes(java.lang.String couponId,
                                 int batchsize)

Generate multi-code coupon codes

Parameters:

couponId - the couponId of related MultiCodeCoupon

batchsize - batch size for generated coupons

Returns:

a link to a generated coupons resource

getSingleCodeCouponRedemption

public CouponRedemptionWsDTO getSingleCodeCouponRedemption(java.lang.String couponId,
                                                           java.lang.String customerId,
                                                           java.lang.String fields)

Request to get a redemption status for a single-code coupon with given couponId

Parameters:

couponId - the couponId of the requested coupon

customerId - the user id

fields - defaulted to DEFAULT but can be FULL or BASIC

Returns:

instance of CouponRedemptionWsDTO, corresponding to couponId

getCodeGenerationConfigurations

@Deprecated
public CodeGenerationConfigurationsSearchPageWsDTO getCodeGenerationConfigurations(java.lang.String fields,
                                                                                               int currentPage,
                                                                                               int pageSize,
                                                                                               java.lang.String sort)

Deprecated. since 6.6 please use next api version /couponservices/v2/codegenerationconfiguration/list defined in CouponservicesV2Controller.getCodeGenerationConfigurations(java.lang.String, int, int, java.lang.String)

Request to get all code generation configuration registered in the system

Parameters:

fields - defaulted to DEFAULT but can be FULL or BASIC

currentPage - number of the current page

pageSize - number of items in a page

sort - sorting the results ascending or descending

Returns:

the list of code generation configuration

getCodeGenerationConfiguration

public CodeGenerationConfigurationWsDTO getCodeGenerationConfiguration(java.lang.String codeGenerationConfigurationName,
                                                                       java.lang.String fields)

Request to get a single-code coupon with given couponId

Parameters:

codeGenerationConfigurationName - the codeGenerationConfigurationName of the requested codeGenerationConfiguration

fields - defaulted to DEFAULT but can be FULL or BASIC

Returns:

instance of CodeGenerationConfigurationWsDTO, corresponding to codeGenerationConfigurationName

validate

protected void validate(java.lang.Object object,
                        java.lang.String objectName,
                        Validator validator)

Validates the object by using the passed validator

Parameters:

object - the object ot be validated

objectName - the object name

validator - validator which will validate the object

getDataMapper

protected DataMapper getDataMapper()

getSingleCodeCouponWsFacades

protected CouponWsFacades<SingleCodeCouponWsDTO> getSingleCodeCouponWsFacades()

getSingleCodeCouponWsDTOValidator

protected Validator getSingleCodeCouponWsDTOValidator()

getCouponStatusWsDTOValidator

protected Validator getCouponStatusWsDTOValidator()

getMultiCodeCouponWsDTOValidator

protected Validator getMultiCodeCouponWsDTOValidator()

getMultiCodeCouponWsFacades

protected CouponWsFacades<MultiCodeCouponWsDTO> getMultiCodeCouponWsFacades()

getCouponCodeGenerationWsFacade

protected CouponCodeGenerationWsFacade getCouponCodeGenerationWsFacade()

getCouponRedemptionWsFacade

protected CouponRedemptionWsFacade getCouponRedemptionWsFacade()

getCodeGenerationConfigurationWsFacade

protected CodeGenerationConfigurationWsFacade getCodeGenerationConfigurationWsFacade()