Package com.apptus.esales.connector

Class Result.Completions

java.lang.Object

com.apptus.esales.connector.Result.Completions

All Implemented Interfaces:

Result, Iterable<Result.Completion>

Enclosing interface:

Result

public static class Result.Completions
extends Object
implements Result, Iterable<Result.Completion>

Represents a result having the completions 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
Completions()

Method Summary

Modifier and Type	Method	Description
List<Result.Completion>	getCompletions()	Get a list of the completions.
Result.ResultType	getType()	Get the result type of this result.
boolean	isEmpty()	Check if this result is empty.
Iterator<Result.Completion>	iterator()
static Result.Completions	mock(List<Result.Completion> completions)	Creates a new Completions object for test purposes.
int	size()	Get the number of completions found.
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

Completions

public Completions()

Method Detail

mock

public static Result.Completions mock(List<Result.Completion> completions)

Creates a new Completions object for test purposes.

Parameters:

completions - the completions to include in the completions result

Returns:

a completions result

size

public final int size()

Get the number of completions found.

Returns:

the number of completions

isEmpty

public final boolean isEmpty()

Check if this result is empty.

Returns:

true if there are no completions, otherwise false

getCompletions

public List<Result.Completion> getCompletions()

Get a list of the completions.

Returns:

the list of completions

iterator

public Iterator<Result.Completion> iterator()

Specified by:

iterator in interface Iterable<Result.Completion>

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