Package com.apptus.esales.connector

Class Result.Product

java.lang.Object

com.apptus.esales.connector.Result.Product

All Implemented Interfaces:

Iterable<Result.Attribute>

Enclosing interface:

Result

public static class Result.Product
extends Object
implements Iterable<Result.Attribute>

Represents a single element in a result having the products format.

Constructor Summary

Constructors

Constructor	Description
Product()

Method Summary

Modifier and Type	Method	Description
Result.Attribute	getAttribute(String name)	Get the attribute with the specified name or null if no such attribute exists for this product.
List<Result.CategoryData>	getCategories(String categoryReferenceAttribute)	Get the category objects of the given category reference attribute.
Set<String>	getCategoryReferenceAttributes()	Get the available category reference attributes in the product.
String	getTicket()	Get the notification ticket of this product.
String	getValue(String attributeName)	Get the attribute with the specified name from this product or null if no such attribute exists.
String	getValue(String attributeName, String defaultValue)	Get the value of the attribute with the specified attributeName.
List<Result.Variant>	getVariants()
Iterator<Result.Attribute>	iterator()
String	key()	Return the key of this product.
static Result.Product	mock(String key, String ticket, List<Result.Variant> variants, List<Result.Attribute> attributes)	Creates a new Product object for test purposes.
static Result.Product	mock(String key, String ticket, List<Result.Variant> variants, List<Result.Attribute> attributes, Map<String,List<Result.CategoryData>> categoryReferenceAttributes)	Creates a new Product object with category references for test purposes.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Product

public Product()

Method Detail

mock

public static Result.Product mock(String key,
                                  String ticket,
                                  List<Result.Variant> variants,
                                  List<Result.Attribute> attributes)

Creates a new Product object for test purposes.

Parameters:

key - the product key

ticket - the product ticket

variants - variants included in the product

attributes - the product attributes

Returns:

a product

mock

public static Result.Product mock(String key,
                                  String ticket,
                                  List<Result.Variant> variants,
                                  List<Result.Attribute> attributes,
                                  Map<String,List<Result.CategoryData>> categoryReferenceAttributes)

Creates a new Product object with category references for test purposes.

Parameters:

key - the product key

ticket - the product ticket

variants - variants included in the product

attributes - the product attributes

categoryReferenceAttributes - map of category data references

Returns:

a product

getAttribute

public final Result.Attribute getAttribute(String name)

Get the attribute with the specified name or null if no such attribute exists for this product.

Parameters:

name - the name of the attribute to get

Returns:

the attribute with the specified name or null

key

public final String key()

Return the key of this product.

Returns:

the key of this product

getValue

public final String getValue(String attributeName)

Get the attribute with the specified name from this product or null if no such attribute exists.

Parameters:

attributeName - The name of the attribute whose value to retrieve

Returns:

The attribute with the specified name or null if this product has no such attribute

getValue

public final String getValue(String attributeName,
                             String defaultValue)

Get the value of the attribute with the specified attributeName. The specified defaultValue will be returned if no such attribute exists.

Parameters:

attributeName - The name of the attribute whose value to retrieve

defaultValue - The value to return if this product doesn't have an attribute with the specified attributeName

Returns:

The attribute value of attribute with the specified attributeName. The supplied defaultValue will be returned if this product has no attribute matching the name

getCategoryReferenceAttributes

public Set<String> getCategoryReferenceAttributes()

Get the available category reference attributes in the product.

Returns:

the available category reference attributes in the product as a Set

getCategories

public List<Result.CategoryData> getCategories(String categoryReferenceAttribute)

Get the category objects of the given category reference attribute.

Parameters:

categoryReferenceAttribute - the category reference attribute to get the categories for

Returns:

the category objects of the categoryReferenceAttribute as a list

iterator

public Iterator<Result.Attribute> iterator()

Specified by:

iterator in interface Iterable<Result.Attribute>

toString

public String toString()

Overrides:

toString in class Object

getTicket

public String getTicket()

Get the notification ticket of this product.

Returns:

the ticket

getVariants

public List<Result.Variant> getVariants()