buzz.getcoco.iot

Class InfoRequest.Search

java.lang.Object

buzz.getcoco.iot.InfoRequest.Search

All Implemented Interfaces:

InfoRequest.Value

Enclosing class:

InfoRequest

public static class InfoRequest.Search
extends java.lang.Object
implements InfoRequest.Value

This class acts as a value of request corresponding to Parameter.Key.REMOTE_SEARCH. aids in making a search request

See Also:

InfoResponse.Search

Field Summary

Fields

Modifier and Type	Field and Description
InfoRequest.SearchCriteria	criteria This encapsulates information such as category, query.
int	offsetIndex Offset of result.
int	requestSearchCount A field to limit length of result.
Parameter.SearchType	searchType This fields describes type of search that need to be performed.
InfoRequest.SortOrder	sortOrder Field that describes how the result should be sorted.
InfoRequest.SortType	sortType Fields that describe the value that should be used while sorting.
Identifier.SourceIdentifier	source Source identifier.

Constructor Summary

Constructors

Constructor and Description
Search(int requestSearchCount, int offsetIndex, Parameter.SearchType searchType, Identifier.SourceIdentifier source, InfoRequest.SortType sortType, InfoRequest.SortOrder sortOrder, InfoRequest.SearchCriteria criteria) A Constructor for this value.

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

requestSearchCount

@SerializedName(value="reqSearchCount")
public final int requestSearchCount

A field to limit length of result.

offsetIndex

@SerializedName(value="offsetIndex")
public final int offsetIndex

Offset of result. NOTE: This is for paging data.

sortType

@SerializedName(value="sortByType")
public final InfoRequest.SortType sortType

Fields that describe the value that should be used while sorting.

sortOrder

@SerializedName(value="sortByOrder")
public final InfoRequest.SortOrder sortOrder

Field that describes how the result should be sorted.

criteria

@SerializedName(value="searchCriteria")
public final InfoRequest.SearchCriteria criteria

This encapsulates information such as category, query.

searchType

@SerializedName(value="searchType")
public final Parameter.SearchType searchType

This fields describes type of search that need to be performed. NOTE: Currently only brand search is available.

source

@SerializedName(value="sourceUri")
public final Identifier.SourceIdentifier source

Source identifier.

Constructor Detail

Search

public Search(int requestSearchCount,
              int offsetIndex,
              Parameter.SearchType searchType,
              Identifier.SourceIdentifier source,
              InfoRequest.SortType sortType,
              InfoRequest.SortOrder sortOrder,
              InfoRequest.SearchCriteria criteria)

A Constructor for this value.

Parameters:

requestSearchCount - search count to be included in InfoResponse.Search

offsetIndex - index for request

searchType - an enum constant denoting type of search to be made, ex: brand Parameter.SearchType

source - An Identifier object comprising complete identification of source

sortType - sort the results in provided type InfoRequest.SortType

sortOrder - define ascending or descending order

criteria - additional search query for search request