Package com.apptus.esales.connector

Class Result.Value

java.lang.Object

com.apptus.esales.connector.Result.Value

Enclosing interface:

Result

public static class Result.Value
extends Object

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

Constructor Summary

Constructors

Constructor	Description
Value()

Method Summary

Modifier and Type	Method	Description
int	getCount()	Get the product count associated with this value.
double	getRelevance()	Deprecated.
String	getText()	Get the text of the value.
String	getTicket()	Deprecated.
boolean	isSelected()	Check if this value is a selected facet value.
static Result.Value	mock(String text, String ticket, int count, double relevance, boolean selected)	Creates a new Value object for test purposes.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Value

public Value()

Method Detail

mock

public static Result.Value mock(String text,
                                String ticket,
                                int count,
                                double relevance,
                                boolean selected)

Creates a new Value object for test purposes.

Parameters:

text - the value text

ticket - the value ticket

count - the value count

relevance - the value relevance

selected - indicates if the value is a facet value that was included in the facets parameter to the panel

Returns:

a value

getText

public String getText()

Get the text of the value.

Returns:

the text

getRelevance

@Deprecated
public double getRelevance()

Deprecated.

Get the relevance associated with this value. No longer outputted by the server, except for test queries, and will return 0.0.

Returns:

the relevance or 0.0.

isSelected

public boolean isSelected()

Check if this value is a selected facet value.

Returns:

true if the value is a facet value that was included in the facets parameter to the panel

getCount

public int getCount()

Get the product count associated with this value.

Returns:

the product count

toString

public String toString()

Overrides:

toString in class Object

getTicket

@Deprecated
public String getTicket()

Deprecated.

This ticket is no longer needed. You can safely stop notifying clicks on values.

Returns:

a valid dummy-ticket