Package com.broadleafcommerce.search.api.domain

Class NotFoundIndexable

java.lang.Object

com.broadleafcommerce.search.api.domain.NotFoundIndexable

All Implemented Interfaces:

Indexable<Object>

public class NotFoundIndexable
extends Object
implements Indexable<Object>

Represents and indexable that was not found when querying a service.

Constructor Summary

Constructors

Constructor	Description
NotFoundIndexable()

Method Summary

Modifier and Type	Method	Description
Object	getId()	Returns the identifier for this object.
Map<String,Object>	getJsonMap()	The raw JSON map representing the Indexable object.
List<Translation>	getTranslations()	Any translations present for this Indexable object.
IndexableType	getType()	Provides a type or "namespace" for documents that are co-mingled in an index.
boolean	isNotFound()	Returns true if the item was not found when querying the service, otherwise false.
void	setId(Object id)
void	setType(IndexableType type)

Methods inherited from class java.lang.Object

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

Constructor Details

NotFoundIndexable

public NotFoundIndexable()

Method Details

getId

public Object getId()

Description copied from interface: Indexable

Returns the identifier for this object. Typically a ULID, UUID, Long, or BigDecimal.

Specified by:

getId in interface Indexable<Object>

Returns:

The ID of the indexable

getType

public IndexableType getType()

Description copied from interface: Indexable

Provides a type or "namespace" for documents that are co-mingled in an index. Allows for filtering by type. e.g. "PRODUCT", "CATEGORY", "ORDER", "STORE", etc.

Specified by:

getType in interface Indexable<Object>

Returns:

the indexable type of the indexable

getJsonMap

public Map<String,Object> getJsonMap()

Description copied from interface: Indexable

The raw JSON map representing the Indexable object.

Specified by:

getJsonMap in interface Indexable<Object>

Returns:

raw JSON map representing the Indexable object

getTranslations

public List<Translation> getTranslations()

Description copied from interface: Indexable

Any translations present for this Indexable object. If the indexable type is not translatable, this will be empty.

Specified by:

getTranslations in interface Indexable<Object>

Returns:

any translations present for this Indexable object

isNotFound

public boolean isNotFound()

Description copied from interface: Indexable

Returns true if the item was not found when querying the service, otherwise false. This indicates that the indexable was deleted. In the case that this is true, only Indexable.getType() and Indexable.getId() will return values.

Specified by:

isNotFound in interface Indexable<Object>

Returns:

setId

public void setId(Object id)

setType

public void setType(IndexableType type)