Skip navigation links

waggle.common.modules.hive.infos
Class XHiveSearchInfo

java.lang.Object
waggle.core.info.XDTO
waggle.common.modules.hive.infos.XHiveSearchInfo

public class XHiveSearchInfo

extends XDTO

XHiveSearchInfo.

Field Summary

XObjectID	FilterConversationID Limit results to those in a specific Conversation (may be null).
XObjectID	FilterCreatorID Limit results to those created by a specific User (may be null).
String	FilterObjectType Limit results to those of a specific type (may be null).
Date	FilterSinceDate Limit results to those created after a specific date (may be null).
XObjectID	FilterTrackID Limit results to those in a specific Track (may be null).
int	FirstResult Ordinal of first result to return.
int	NumResults Number of results to return.
XDocumentSearchOrder	OrderBy The sort order for returned hits.
String	SearchTerm The search term to be applied.

Constructor Summary

XHiveSearchInfo()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SearchTerm

public String SearchTerm

The search term to be applied.

OrderBy

public XDocumentSearchOrder OrderBy

The sort order for returned hits.

FilterCreatorID

public XObjectID FilterCreatorID

Limit results to those created by a specific User (may be null).

FilterTrackID

public XObjectID FilterTrackID

Limit results to those in a specific Track (may be null).

FilterConversationID

public XObjectID FilterConversationID

Limit results to those in a specific Conversation (may be null).

FilterObjectType

public String FilterObjectType

Limit results to those of a specific type (may be null). Valid types include: Message, Document, Track, Conversation, User, or Tag.

FilterSinceDate

public Date FilterSinceDate

Limit results to those created after a specific date (may be null).

NumResults

public int NumResults

Number of results to return.

FirstResult

public int FirstResult

Ordinal of first result to return. Use this in conjunction with NumResults to page results. For example, to get the first ten results, use NumResults=10, FirstResult=1. To get the next ten results, use NumResults=10, FirstResult=11;

Constructor Detail

XHiveSearchInfo

public XHiveSearchInfo()

Skip navigation links