Package de.hybris.platform.b2ctelcotmfwebservices.v3.api

Interface ProductOfferingApi

All Known Implementing Classes:

TmaProductOfferingApiController

public interface ProductOfferingApi

Interface handling operations for ProductOffering.

Since:

2302

Method Summary

Modifier and Type	Method	Description
org.springframework.http.ResponseEntity<ProductOffering>	createProductOffering(@Valid ProductOffering body, @Valid String baseSiteId, @Valid String catalogId, @Valid String catalogVersion)
org.springframework.http.ResponseEntity<Void>	deleteProductOffering(String id, @Valid String baseSiteId, @Valid String catalogId, @Valid String catalogVersion)
org.springframework.http.ResponseEntity<List<ProductOffering>>	listProductOffering(@Valid String baseSiteId, @Valid String fields, @Valid String name, @Valid String offeringGroupId, @Valid Boolean isBundle, @Valid String parentBundledProductOfferingId, @Valid String lastUpdate, @Valid String lifecycleStatus, @Valid Date validForStartDateTime, @Valid Date validForEndDateTime, @Valid String version, @Valid String _atType, @Valid String _atBaseType, @Valid String _atSchemaLocation, @Valid String placeName, @Valid String placeAddress, @Valid String placeAtReferredType, @Valid String placeRole, @Valid String serviceLevelAgreementName, @Valid String serviceLevelAgreementAtReferredType, @Valid String productSpecificationVersion, @Valid String productSpecificationName, @Valid String productSpecificationAtReferredType, @Valid String channelName, @Valid String channelAtReferredType, @Valid String serviceCandidateVersion, @Valid String serviceCandidateName, @Valid String serviceCandidateAtReferredType, @Valid String attachmentType, @Valid String attachmentUrl, @Valid String attachmentMimeType, @Valid String attachmentAtType, @Valid String attachmentAtBaseType, @Valid String attachmentAtSchemaLocation, @Valid String categoryVersion, @Valid String categoryName, @Valid String categoryAtReferredType, @Valid String resourceCandidateVersion, @Valid String resourceCandidateName, @Valid String resourceCandidateAtReferredType, @Valid String productOfferingTermName, @Valid String productOfferingTermAtType, @Valid String productOfferingTermAtSchemaLocation, @Valid String marketSegmentName, @Valid String marketSegmentAtReferredType, @Valid String productOfferingPriceName, @Valid String productOfferingPricePriceType, @Valid String productOfferingPriceUnitOfMeasure, @Valid String productOfferingPriceRecurringChargePeriod, @Valid String productOfferingPriceVersion, @Valid String productOfferingPriceAtType, @Valid String productOfferingPriceAtBaseType, @Valid String productOfferingPriceAtSchemaLocation, @Valid Boolean productOfferingPriceIsBundle, @Valid String agreementName, @Valid String agreementAtReferredType, @Valid String bundledProductOfferingLifecycleStatus, @Valid String bundledProductOfferingName, @Valid String prodSpecCharValueUseName, @Valid String prodSpecCharValueUseValueType, @Valid Integer prodSpecCharValueUseMinCardinality, @Valid Integer prodSpecCharValueUseMaxCardinality, @Valid String priceContextPlaceId, @Valid List<String> facetSearchOptionId, @Valid List<String> sort, @Valid String priceContextRelatedPartyId, @Valid Integer offset, @Valid Integer limit)
org.springframework.http.ResponseEntity<ProductOffering>	patchProductOffering(String id, @Valid ProductOffering body, @Valid String baseSiteId, @Valid String catalogId, @Valid String catalogVersion)
org.springframework.http.ResponseEntity<List<ProductOffering>>	retrieveProductOffering(String id, @Valid String fields, @Valid String baseSiteId, @Valid String catalogId, @Valid String catalogVersion, @Valid List<String> priceContextProcessTypeId, @Valid String priceContextPlaceId, @Valid String priceContextRelatedPartyId)

Method Details

createProductOffering

@RequestMapping(value="/productOffering",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=POST)
org.springframework.http.ResponseEntity<ProductOffering> createProductOffering(@Valid @RequestBody
 @Valid ProductOffering body,
 @Valid @RequestParam(value="baseSiteId",required=false)
 @Valid String baseSiteId,
 @Valid @RequestParam(value="catalogId",required=false)
 @Valid String catalogId,
 @Valid @RequestParam(value="catalogVersion",required=false)
 @Valid String catalogVersion)

deleteProductOffering

@RequestMapping(value="/productOffering/{id}",
                produces="application/json;charset=utf-8",
                method=DELETE)
org.springframework.http.ResponseEntity<Void> deleteProductOffering(@PathVariable("id")
 String id,
 @Valid @RequestParam(value="baseSiteId",required=false)
 @Valid String baseSiteId,
 @Valid @RequestParam(value="catalogId",required=false)
 @Valid String catalogId,
 @Valid @RequestParam(value="catalogVersion",required=false)
 @Valid String catalogVersion)

listProductOffering

@RequestMapping(value="/productOffering",
                produces="application/json;charset=utf-8",
                method=GET)
org.springframework.http.ResponseEntity<List<ProductOffering>> listProductOffering(@Valid @RequestParam(value="baseSiteId",required=false)
 @Valid String baseSiteId,
 @Valid @RequestParam(value="fields",required=false)
 @Valid String fields,
 @Valid @RequestParam(value="name",required=false)
 @Valid String name,
 @Valid @RequestParam(value="offeringGroup.id",required=false)
 @Valid String offeringGroupId,
 @Valid @RequestParam(value="isBundle",required=false)
 @Valid Boolean isBundle,
 @Valid @RequestParam(value="parentBundledProductOffering.id",required=false)
 @Valid String parentBundledProductOfferingId,
 @Valid @RequestParam(value="lastUpdate",required=false)
 @Valid String lastUpdate,
 @Valid @RequestParam(value="lifecycleStatus",required=false)
 @Valid String lifecycleStatus,
 @Valid @RequestParam(value="validFor.startDateTime",required=false)
 @Valid Date validForStartDateTime,
 @Valid @RequestParam(value="validFor.endDateTime",required=false)
 @Valid Date validForEndDateTime,
 @Valid @RequestParam(value="version",required=false)
 @Valid String version,
 @Valid @RequestParam(value="@type",required=false)
 @Valid String _atType,
 @Valid @RequestParam(value="@baseType",required=false)
 @Valid String _atBaseType,
 @Valid @RequestParam(value="@schemaLocation",required=false)
 @Valid String _atSchemaLocation,
 @Valid @RequestParam(value="place.name",required=false)
 @Valid String placeName,
 @Valid @RequestParam(value="place.address",required=false)
 @Valid String placeAddress,
 @Valid @RequestParam(value="place.@referredType",required=false)
 @Valid String placeAtReferredType,
 @Valid @RequestParam(value="place.role",required=false)
 @Valid String placeRole,
 @Valid @RequestParam(value="serviceLevelAgreement.name",required=false)
 @Valid String serviceLevelAgreementName,
 @Valid @RequestParam(value="serviceLevelAgreement.@referredType",required=false)
 @Valid String serviceLevelAgreementAtReferredType,
 @Valid @RequestParam(value="productSpecification.version",required=false)
 @Valid String productSpecificationVersion,
 @Valid @RequestParam(value="productSpecification.name",required=false)
 @Valid String productSpecificationName,
 @Valid @RequestParam(value="productSpecification.@referredType",required=false)
 @Valid String productSpecificationAtReferredType,
 @Valid @RequestParam(value="channel.name",required=false)
 @Valid String channelName,
 @Valid @RequestParam(value="channel.@referredType",required=false)
 @Valid String channelAtReferredType,
 @Valid @RequestParam(value="serviceCandidate.version",required=false)
 @Valid String serviceCandidateVersion,
 @Valid @RequestParam(value="serviceCandidate.name",required=false)
 @Valid String serviceCandidateName,
 @Valid @RequestParam(value="serviceCandidate.@referredType",required=false)
 @Valid String serviceCandidateAtReferredType,
 @Valid @RequestParam(value="attachment.type",required=false)
 @Valid String attachmentType,
 @Valid @RequestParam(value="attachment.url",required=false)
 @Valid String attachmentUrl,
 @Valid @RequestParam(value="attachment.mimeType",required=false)
 @Valid String attachmentMimeType,
 @Valid @RequestParam(value="attachment.@type",required=false)
 @Valid String attachmentAtType,
 @Valid @RequestParam(value="attachment.@baseType",required=false)
 @Valid String attachmentAtBaseType,
 @Valid @RequestParam(value="attachment.@schemaLocation",required=false)
 @Valid String attachmentAtSchemaLocation,
 @Valid @RequestParam(value="category.version",required=false)
 @Valid String categoryVersion,
 @Valid @RequestParam(value="category.name",required=false)
 @Valid String categoryName,
 @Valid @RequestParam(value="category.@referredType",required=false)
 @Valid String categoryAtReferredType,
 @Valid @RequestParam(value="resourceCandidate.version",required=false)
 @Valid String resourceCandidateVersion,
 @Valid @RequestParam(value="resourceCandidate.name",required=false)
 @Valid String resourceCandidateName,
 @Valid @RequestParam(value="resourceCandidate.@referredType",required=false)
 @Valid String resourceCandidateAtReferredType,
 @Valid @RequestParam(value="productOfferingTerm.name",required=false)
 @Valid String productOfferingTermName,
 @Valid @RequestParam(value="productOfferingTerm.@type",required=false)
 @Valid String productOfferingTermAtType,
 @Valid @RequestParam(value="productOfferingTerm.@schemaLocation",required=false)
 @Valid String productOfferingTermAtSchemaLocation,
 @Valid @RequestParam(value="marketSegment.name",required=false)
 @Valid String marketSegmentName,
 @Valid @RequestParam(value="marketSegment.@referredType",required=false)
 @Valid String marketSegmentAtReferredType,
 @Valid @RequestParam(value="productOfferingPrice.name",required=false)
 @Valid String productOfferingPriceName,
 @Valid @RequestParam(value="productOfferingPrice.priceType",required=false)
 @Valid String productOfferingPricePriceType,
 @Valid @RequestParam(value="productOfferingPrice.unitOfMeasure",required=false)
 @Valid String productOfferingPriceUnitOfMeasure,
 @Valid @RequestParam(value="productOfferingPrice.recurringChargePeriod",required=false)
 @Valid String productOfferingPriceRecurringChargePeriod,
 @Valid @RequestParam(value="productOfferingPrice.version",required=false)
 @Valid String productOfferingPriceVersion,
 @Valid @RequestParam(value="productOfferingPrice.@type",required=false)
 @Valid String productOfferingPriceAtType,
 @Valid @RequestParam(value="productOfferingPrice.@baseType",required=false)
 @Valid String productOfferingPriceAtBaseType,
 @Valid @RequestParam(value="productOfferingPrice.@schemaLocation",required=false)
 @Valid String productOfferingPriceAtSchemaLocation,
 @Valid @RequestParam(value="productOfferingPrice.isBundle",required=false)
 @Valid Boolean productOfferingPriceIsBundle,
 @Valid @RequestParam(value="agreement.name",required=false)
 @Valid String agreementName,
 @Valid @RequestParam(value="agreement.@referredType",required=false)
 @Valid String agreementAtReferredType,
 @Valid @RequestParam(value="bundledProductOffering.lifecycleStatus",required=false)
 @Valid String bundledProductOfferingLifecycleStatus,
 @Valid @RequestParam(value="bundledProductOffering.name",required=false)
 @Valid String bundledProductOfferingName,
 @Valid @RequestParam(value="prodSpecCharValueUse.name",required=false)
 @Valid String prodSpecCharValueUseName,
 @Valid @RequestParam(value="prodSpecCharValueUse.valueType",required=false)
 @Valid String prodSpecCharValueUseValueType,
 @Valid @RequestParam(value="prodSpecCharValueUse.minCardinality",required=false)
 @Valid Integer prodSpecCharValueUseMinCardinality,
 @Valid @RequestParam(value="prodSpecCharValueUse.maxCardinality",required=false)
 @Valid Integer prodSpecCharValueUseMaxCardinality,
 @Valid @RequestParam(value="priceContext.place.id",required=false)
 @Valid String priceContextPlaceId,
 @Valid @RequestParam(value="facetSearchOption.id",required=false)
 @Valid List<String> facetSearchOptionId,
 @Valid @RequestParam(value="sort",required=false)
 @Valid List<String> sort,
 @Valid @RequestParam(value="priceContext.relatedParty.id",required=false)
 @Valid String priceContextRelatedPartyId,
 @Valid @RequestParam(value="offset",required=false)
 @Valid Integer offset,
 @Valid @RequestParam(value="limit",required=false)
 @Valid Integer limit)

patchProductOffering

@RequestMapping(value="/productOffering/{id}",
                produces="application/json;charset=utf-8",
                consumes="application/json;charset=utf-8",
                method=PATCH)
org.springframework.http.ResponseEntity<ProductOffering> patchProductOffering(@PathVariable("id")
 String id,
 @Valid @RequestBody
 @Valid ProductOffering body,
 @Valid @RequestParam(value="baseSiteId",required=false)
 @Valid String baseSiteId,
 @Valid @RequestParam(value="catalogId",required=false)
 @Valid String catalogId,
 @Valid @RequestParam(value="catalogVersion",required=false)
 @Valid String catalogVersion)

retrieveProductOffering

@RequestMapping(value="/productOffering/{id}",
                produces="application/json;charset=utf-8",
                method=GET)
org.springframework.http.ResponseEntity<List<ProductOffering>> retrieveProductOffering(@PathVariable("id")
 String id,
 @Valid @RequestParam(value="fields",required=false)
 @Valid String fields,
 @Valid @RequestParam(value="baseSiteId",required=false)
 @Valid String baseSiteId,
 @Valid @RequestParam(value="catalogId",required=false)
 @Valid String catalogId,
 @Valid @RequestParam(value="catalogVersion",required=false)
 @Valid String catalogVersion,
 @Valid @RequestParam(value="priceContext.processType.id",required=false)
 @Valid List<String> priceContextProcessTypeId,
 @Valid @RequestParam(value="priceContext.place.id",required=false)
 @Valid String priceContextPlaceId,
 @Valid @RequestParam(value="priceContext.relatedParty.id",required=false)
 @Valid String priceContextRelatedPartyId)