Package com.apptus.esales.connector

Class Result.Ads

java.lang.Object

com.apptus.esales.connector.Result.Ads

All Implemented Interfaces:

Result, Iterable<Result.Ad>

Enclosing interface:

Result

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

Represents a result having the ads format.

Nested Class Summary

Nested classes/interfaces inherited from interface com.apptus.esales.connector.Result

Result.Ad, Result.Ads, Result.Attribute, Result.Category, Result.CategoryData, Result.CategoryList, Result.CategoryNode, Result.Completion, Result.Completions, Result.Correction, Result.Corrections, Result.Count, Result.Facet, Result.FacetList, Result.FacetRange, Result.Phrase, Result.Phrases, Result.Product, Result.Products, Result.ResultType, Result.Value, Result.Values, Result.Variant

Constructor Summary

Constructors

Constructor	Description
Ads()

Method Summary

Modifier and Type	Method	Description
List<Result.Ad>	getAds()	Get the list of ads in this result.
Result.ResultType	getType()	Get the result type of this result.
boolean	isEmpty()	Return true if this result is empty and false otherwise.
Iterator<Result.Ad>	iterator()
static Result.Ads	mock(List<Result.Ad> ads)	Creates a new Ads object for test purposes.
int	size()	The number of ads in this result.
String	toString()

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Constructor Detail

Ads

public Ads()

Method Detail

mock

public static Result.Ads mock(List<Result.Ad> ads)

Creates a new Ads object for test purposes.

Parameters:

ads - the ads to include in the ads result

Returns:

an ads result

getAds

public final List<Result.Ad> getAds()

Get the list of ads in this result.

Returns:

the list of ads

size

public final int size()

The number of ads in this result.

Returns:

the number of ads in this result

isEmpty

public final boolean isEmpty()

Return true if this result is empty and false otherwise.

Returns:

true if this result is empty and false otherwise

iterator

public Iterator<Result.Ad> iterator()

Specified by:

iterator in interface Iterable<Result.Ad>

toString

public String toString()

Specified by:

toString in interface Result

Overrides:

toString in class Object

getType

public Result.ResultType getType()

Description copied from interface: Result

Get the result type of this result.

Specified by:

getType in interface Result

Returns:

the result type