Package com.apptus.esales.connector

Class Result.Ad

java.lang.Object

com.apptus.esales.connector.Result.Ad

All Implemented Interfaces:

Iterable<Result.Attribute>

Enclosing interface:

Result

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

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

Constructor Summary

Constructors

Constructor	Description
Ad()

Method Summary

Modifier and Type	Method	Description
String	campaignKey()	Return the campaign key of this ad.
Result.Attribute	getAttribute(String name)	Get the attribute with the specified name or null if no such attribute exists for this ad.
TimePoint	getEndTime()	Get the end time or null if no such attribute exists for this ad.
Filter	getIncluded()	Get the "included" attribute or null if no such attribute exists for this ad.
Result.Products	getProducts()
Filter	getRelated()	Get the "related" attribute or null if no such attribute exists for this ad.
TimePoint	getStartTime()	Get the start time or null if no such attribute exists for this ad.
String	getTicket()	Get the notification ticket of this ad.
String	getValue(String attributeName)	Get the attribute with the specified name from this ad 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 ad.
static Result.Ad	mock(String key, String ticket, TimePoint startTime, TimePoint endTime, Filter included, Filter related, String campaignKey, Result.Products products, List<Result.Attribute> attributes)	Creates a new Ad object 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

Ad

public Ad()

Method Detail

mock

public static Result.Ad mock(String key,
                             String ticket,
                             TimePoint startTime,
                             TimePoint endTime,
                             Filter included,
                             Filter related,
                             String campaignKey,
                             Result.Products products,
                             List<Result.Attribute> attributes)

Creates a new Ad object for test purposes.

Parameters:

key - the ad key

ticket - the ad ticket

startTime - the ad start time

endTime - the ad end time

included - the ad inclusion filter

related - the ad related filter

campaignKey - the ad campaign key

products - the products of this ad

attributes - the ad attributes

Returns:

an ad

getAttribute

public final Result.Attribute getAttribute(String name)

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

Parameters:

name - the name of the attribute to get

Returns:

the attribute with the specified name or null

getStartTime

public final TimePoint getStartTime()

Get the start time or null if no such attribute exists for this ad.

Returns:

the start time or null

getEndTime

public final TimePoint getEndTime()

Get the end time or null if no such attribute exists for this ad.

Returns:

the end time or null

getIncluded

public final Filter getIncluded()

Get the "included" attribute or null if no such attribute exists for this ad.

Returns:

the included or null

getRelated

public final Filter getRelated()

Get the "related" attribute or null if no such attribute exists for this ad.

Returns:

the included or null

campaignKey

public final String campaignKey()

Return the campaign key of this ad.

Returns:

the campaign key of this ad

key

public final String key()

Return the key of this ad.

Returns:

the key of this ad

getValue

public final String getValue(String attributeName)

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

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

Returns:

the ticket

getProducts

public Result.Products getProducts()