de.hybris.platform.print.util

Interface VariantUtils

All Known Implementing Classes:

VariantUtilsImpl

public interface VariantUtils

Utility class that provides functions to get and process data from base- and variant products

Method Summary

Modifier and Type	Method and Description
String	getAllVariantAttributeValues(Product baseProduct) Returns a String containing the values of any variant attributes of the given base product (delimited by the default attribute delimiter '; ', the default value delimiter ', ' and the default value preamble ': ') Example: 'color: red, green, blue; size: 8, 9, 10, 11'
String	getAllVariantAttributeValues(Product baseProduct, boolean includeAttributeName, String attributeDelimiter, String valuePreamble, String valueDelimiter) Returns a String containing the values of any variant attributes of the given base product Example: 'color: red, green, blue; size: 8, 9, 10, 11'
String	getAllVariantAttributeValues(Product baseProduct, String attributeDelimiter, String valuePreamble, String valueDelimiter) Returns a String containing the values of any variant attributes of the given base product Example: 'color: red, green, blue; size: 8, 9, 10, 11'
String	getVariantAttributeValue(Product baseProduct, String attributeQualifier) Returns a String containing the values of the specified variant attribute of the given base product (delimited by the default value delimiter ', ' and the default value preamble ': ') Example: 'color: red, green, blue'
String	getVariantAttributeValue(Product baseProduct, String attributeQualifier, boolean includeAttributeName, String valuePreamble, String valueDelimiter) Returns a String containing the values of the specified variant attributes of the given base product (delimited by the the default value delimiter ', ' and the default value preamble ': ') Example: 'color: red, green, blue; size: 8, 9, 10, 11'
String	getVariantAttributeValue(Product baseProduct, String attributeQualifier, String valuePreamble, String valueDelimiter) Returns a String containing the values of the specified variant attributes of the given base product (delimited by the the default value delimiter ', ' and the default value preamble ': ') Example: 'color: red, green, blue; size: 8, 9, 10, 11'

Method Detail

getAllVariantAttributeValues

String getAllVariantAttributeValues(Product baseProduct)

Returns a String containing the values of any variant attributes of the given base product (delimited by the default attribute delimiter '; ', the default value delimiter ', ' and the default value preamble ': ')
Example: 'color: red, green, blue; size: 8, 9, 10, 11'

Parameters:

baseProduct - The base product from which to get the variant attributes

Returns:

The values of all variant attributes

getAllVariantAttributeValues

String getAllVariantAttributeValues(Product baseProduct,
                                    String attributeDelimiter,
                                    String valuePreamble,
                                    String valueDelimiter)

Returns a String containing the values of any variant attributes of the given base product
Example: 'color: red, green, blue; size: 8, 9, 10, 11'

Parameters:

baseProduct - The base product from which to get the variant attributes

attributeDelimiter - The sign that delimites attributes (could be null, default is the linebreak '\n')

valuePreamble - The sign that delimites the attribute name from the values (could be null, default is ': ')

valueDelimiter - The sign that delimites attribute values (could be null, default is ', ')

Returns:

The values of all variant attributes

getAllVariantAttributeValues

String getAllVariantAttributeValues(Product baseProduct,
                                    boolean includeAttributeName,
                                    String attributeDelimiter,
                                    String valuePreamble,
                                    String valueDelimiter)

Returns a String containing the values of any variant attributes of the given base product
Example: 'color: red, green, blue; size: 8, 9, 10, 11'

Parameters:

baseProduct - The base product from which to get the variant attributes

includeAttributeName - If true, the name of each variant attribute is prepended to the values

attributeDelimiter - The sign that delimites attributes (could be null, default is the linebreak '\n')

valuePreamble - The sign that delimites the attribute name from the values (could be null, default is ': ')

valueDelimiter - The sign that delimites attribute values (could be null, default is ', ')

Returns:

The values of all variant attributes

getVariantAttributeValue

String getVariantAttributeValue(Product baseProduct,
                                String attributeQualifier)

Returns a String containing the values of the specified variant attribute of the given base product (delimited by the default value delimiter ', ' and the default value preamble ': ')
Example: 'color: red, green, blue'

Parameters:

baseProduct - The base product from which to get the variant attributes

attributeQualifier - The qualifier of the variant attribute

Returns:

The values of all variant attributes

getVariantAttributeValue

String getVariantAttributeValue(Product baseProduct,
                                String attributeQualifier,
                                String valuePreamble,
                                String valueDelimiter)

Returns a String containing the values of the specified variant attributes of the given base product (delimited by the the default value delimiter ', ' and the default value preamble ': ')
Example: 'color: red, green, blue; size: 8, 9, 10, 11'

Parameters:

baseProduct - The base product from which to get the variant attributes

attributeQualifier - The qualifier of the variant attribute

valuePreamble - The sign that delimites the attribute name from the values (could be null, default is ': ')

valueDelimiter - The sign that delimites attribute values (could be null, default is ', ')

Returns:

The values of all variant attributes

getVariantAttributeValue

String getVariantAttributeValue(Product baseProduct,
                                String attributeQualifier,
                                boolean includeAttributeName,
                                String valuePreamble,
                                String valueDelimiter)

Returns a String containing the values of the specified variant attributes of the given base product (delimited by the the default value delimiter ', ' and the default value preamble ': ')
Example: 'color: red, green, blue; size: 8, 9, 10, 11'

Parameters:

baseProduct - The base product from which to get the variant attributes

attributeQualifier - The qualifier of the variant attribute

includeAttributeName - If true, the name of each variant attribute is prepended to the values

valuePreamble - The sign that delimites the attribute name from the values (could be null, default is ': ')

valueDelimiter - The sign that delimites attribute values (could be null, default is ', ')

Returns:

The values of all variant attributes