Package com.apptus.esales.connector

Class Result.Variant

java.lang.Object

com.apptus.esales.connector.Result.Variant

All Implemented Interfaces:

Iterable<Result.Attribute>

Enclosing interface:

Result

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

Represents a product variant.

Constructor Summary

Constructors

Constructor	Description
Variant()

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 variant.
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 variant.
String	getValue(String attributeName)	Get the attribute with the specified name from this variant or null if no such attribute exists.
String	getValue(String attributeName, String defaultValue)	Get the value of the attribute with the specified attributeName.
Iterator<Result.Attribute>	iterator()
String	key()	Return the key of this variant.
static Result.Variant	mock(String key, String ticket, List<Result.Attribute> attributes)	Creates a new Variant object for test purposes.
static Result.Variant	mock(String key, String ticket, List<Result.Attribute> attributes, Map<String,List<Result.CategoryData>> categoryReferenceAttributes)	Creates a new Variant 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

Variant

public Variant()

Method Detail

mock

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

Creates a new Variant object for test purposes.

Parameters:

key - the variant key

ticket - the variant ticket

attributes - the variant attributes

Returns:

a variant

mock

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

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

Parameters:

key - the variant key

ticket - the variant ticket

attributes - the variant attributes

categoryReferenceAttributes - map of category data references

Returns:

a variant

getAttribute

public final Result.Attribute getAttribute(String name)

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

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 variant.

Returns:

the key of this variant

getValue

public final String getValue(String attributeName)

Get the attribute with the specified name from this variant 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 variant 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 variant 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 variant has no attribute matching the name

getTicket

public String getTicket()

Get the notification ticket of this variant.

Returns:

the ticket

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