Package net.bluemind.backend.mail.api

Class SearchQuery

java.lang.Object

net.bluemind.backend.mail.api.SearchQuery

public class SearchQuery
extends Object

Defines message search parameters

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchQuery.FolderScope	Definition of a MailboxFolder search restriction
static class	SearchQuery.Header	Header key/value pair
static class	SearchQuery.HeaderQuery	Header search
static enum	SearchQuery.LogicalOperator	Defines the search operator of the requested header search values
static class	SearchQuery.SearchScope	The scope of a search

Field Summary

Fields

Modifier and Type	Field	Description
SearchQuery.HeaderQuery	headerQuery	Enables the search by the specific header values
SearchQuery.LogicalOperator	logicalOperator	Defines the default search operator of query and recordQuery
long	maxResults	Maximum results
String	messageId	Enables the search by the MessageId header
long	offset	Result Set offset
String	query	An Elasticsearch compliant query string body document only
String	recordQuery	An Elasticsearch compliant query string record document only
String	references	Enables the search by the References header
SearchQuery.SearchScope	scope	The scope of this search
String	searchSessionId	An optional id associated to this query

Constructor Summary

Constructors

Constructor	Description
SearchQuery()

Method Summary

Modifier and Type	Method	Description
static SearchQuery	allHeaders(Map<String,String> headerValues, SearchQuery.LogicalOperator operator)

Methods inherited from class java.lang.Object

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

Field Details

searchSessionId

public String searchSessionId

An optional id associated to this query

query

public String query

An Elasticsearch compliant query string body document only

recordQuery

public String recordQuery

An Elasticsearch compliant query string record document only

messageId

public String messageId

Enables the search by the MessageId header

references

public String references

Enables the search by the References header

headerQuery

public SearchQuery.HeaderQuery headerQuery

Enables the search by the specific header values

maxResults

public long maxResults

Maximum results

offset

public long offset

Result Set offset

scope

public SearchQuery.SearchScope scope

The scope of this search

logicalOperator

public SearchQuery.LogicalOperator logicalOperator

Defines the default search operator of query and recordQuery

Constructor Details

SearchQuery

public SearchQuery()

Method Details

allHeaders

public static SearchQuery allHeaders(Map<String,String> headerValues,
 SearchQuery.LogicalOperator operator)