Skip navigation links

waggle.common.modules.hive.infos
Class XHiveFindSimilarInfo

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

public class XHiveFindSimilarInfo

extends XDTO

XHiveFindSimilarInfo, DTO to specify parameters to a "Find Similar" search.

Field Summary

List<String>	AttachmentNames Names of documents attached to the email.
String	BodyText The body of the email, as plain text or HTML.
List<String>	Categories Categories applied to the email.
int	FirstResult Ordinal of first result to return.
List<String>	Flags Flags applied to the email.
int	NumResults Number of results to return.
List<String>	Recipients Users (such as email recipients).
String	Subject The subject of the email.

Constructor Summary

XHiveFindSimilarInfo()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

Subject

public String Subject

The subject of the email. Must not be null.

BodyText

public String BodyText

The body of the email, as plain text or HTML. May be null.

Recipients

public List<String> Recipients

Users (such as email recipients). Specify as usernames (email addresses). May be null.

Categories

public List<String> Categories

Categories applied to the email. May be null.

Flags

public List<String> Flags

Flags applied to the email. May be null.

AttachmentNames

public List<String> AttachmentNames

Names of documents attached to the email. 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

XHiveFindSimilarInfo

public XHiveFindSimilarInfo()

Skip navigation links