Package de.hybris.platform.sap.sapordermgmtbol.transaction.item.businessobject.interf

Interface AlternativeProductList

All Superinterfaces:

java.lang.Cloneable, java.lang.Iterable<AlternativeProduct>, SimpleListAccess<AlternativeProduct>

All Known Implementing Classes:

AlternativeProductListImpl

public interface AlternativeProductList
extends SimpleListAccess<AlternativeProduct>, java.lang.Cloneable

Represents the backend's view of List of AlternativProducts.
In some cases the back end may return a list of alternatives for a entered product, for example if the product was not unique, or if several substitutions are possible.

Version:

1.0

Method Summary

Modifier and Type	Method	Description
void	addAlternativProduct(int i, AlternativeProduct altProd)	sets the alternative product for the given index
void	addAlternativProduct(AlternativeProduct altProd)	sets the alternative product for the given index
void	addAlternativProduct(java.lang.String systemProductId, TechKey systemProductGUID, java.lang.String description, java.lang.String enteredProductIdType, java.lang.String substitutionReasonId)	Creates and adds an alternative Product to the ProductAliasList
void	clear()	clear the alternativ product list
java.lang.Object	clone()	Performs a deep copy of this object.
AlternativeProduct	createAlternativProduct()	Creates an empty AlternativProductData for the basket.
AlternativeProduct	createAlternativProduct(java.lang.String systemProductId, TechKey systemProductGUID, java.lang.String description, java.lang.String enteredProductIdType, java.lang.String substitutionReasonId)	Creates a initialised AlternativProductData for the basket.
boolean	isEmpty()	returns true if the alternative product list is empty
void	setList(java.util.List<AlternativeProduct> altProdList)	sets the alternative product list
int	size()	get the size of the list of alternative products

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface de.hybris.platform.sap.sapcommonbol.transaction.businessobject.transfer.interf.SimpleListAccess

iterator

Method Detail

createAlternativProduct

AlternativeProduct createAlternativProduct()

Creates an empty AlternativProductData for the basket.

Returns:

AlternativProduct which can added to the alternativProductList

createAlternativProduct

AlternativeProduct createAlternativProduct(java.lang.String systemProductId,
                                           TechKey systemProductGUID,
                                           java.lang.String description,
                                           java.lang.String enteredProductIdType,
                                           java.lang.String substitutionReasonId)

Creates a initialised AlternativProductData for the basket.

Parameters:

systemProductId - id of the system product

systemProductGUID - techkey of the system product

description - description of the system product

enteredProductIdType - if the system product was found through determination, this specifies, as what the entred product id was interpreted

substitutionReasonId - if the system product is a substitute product, this is the id for the substitution reason

Returns:

AlternativProduct which can added to the AlternativProductList

clear

void clear()

clear the alternativ product list

size

int size()

get the size of the list of alternative products

Specified by:

size in interface SimpleListAccess<AlternativeProduct>

Returns:

size of the list

isEmpty

boolean isEmpty()

returns true if the alternative product list is empty

Specified by:

isEmpty in interface SimpleListAccess<AlternativeProduct>

Returns:

boolean

addAlternativProduct

void addAlternativProduct(int i,
                          AlternativeProduct altProd)

sets the alternative product for the given index

Parameters:

i - index to set the product

altProd - the alternative product for the given index, or null if index is out of bounds

addAlternativProduct

void addAlternativProduct(AlternativeProduct altProd)

sets the alternative product for the given index

Parameters:

altProd - the alternative product for the given index, or null if index is out of bounds

addAlternativProduct

void addAlternativProduct(java.lang.String systemProductId,
                          TechKey systemProductGUID,
                          java.lang.String description,
                          java.lang.String enteredProductIdType,
                          java.lang.String substitutionReasonId)

Creates and adds an alternative Product to the ProductAliasList

Parameters:

systemProductId - id of the system product

systemProductGUID - techkey of the system product

description - description of the system product

enteredProductIdType - if the system product was found through determination, this specifies, as what the entered product id was interpreted

substitutionReasonId - if the system product is a substitute product, this is the id for the substitution reason

setList

void setList(java.util.List<AlternativeProduct> altProdList)

sets the alternative product list

Parameters:

altProdList - List new list of alternative products

clone

java.lang.Object clone()

Performs a deep copy of this object. Hence the List of alternative products will be duplicated.

Returns:

deep copy of this object