com.primus.searchstudio
Class ViewResult

java.lang.Object
  com.primus.searchstudio.ViewResult

All Implemented Interfaces:

java.io.Serializable

public final class ViewResult
extends java.lang.Object
implements java.io.Serializable

Output (result) value object for ViewInContext EJB.

See Also:

Serialized Form

Field Summary

static int	RESULT_TYPE_HTML_DOCUMENT The return value of getResult() is an HTML document.
static int	RESULT_TYPE_URL The return value of getResult() is a URL.

Constructor Summary

ViewResult(int resultType, java.lang.String result)
Creates a new "view in context" result.

ViewResult(java.lang.String mode, java.lang.String input, java.lang.String docContextID, java.lang.String highlightInfo)

Method Summary

java.lang.String	getDocContextID()
com.primus.searchstudio.ResultDocument	getDocument() returns doc info when returnType is information
java.lang.String	getHighlightInfo() returns highlight information
java.lang.String	getInput()
java.lang.String	getMode() returns mode
java.lang.String	getResult() Gets the result.
int	getResultType() Gets the result type.
void	setDocContextID(java.lang.String pDocContextID)
void	setDocument(com.primus.searchstudio.ResultDocument document) sets the document
void	setHighlightInfo(java.lang.String pHighlightInfo)
void	setInput(java.lang.String pInput)
void	setMode(java.lang.String pMode)
void	setResult(java.lang.String result)
void	setResultType(int pResultType)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

RESULT_TYPE_HTML_DOCUMENT

public static final int RESULT_TYPE_HTML_DOCUMENT

The return value of getResult() is an HTML document.

See Also:

Constant Field Values

RESULT_TYPE_URL

public static final int RESULT_TYPE_URL

The return value of getResult() is a URL.

See Also:

Constant Field Values

Constructor Detail

ViewResult

public ViewResult(int resultType,
                  java.lang.String result)

Creates a new "view in context" result.

Parameters:

resultType - result type

result - result

ViewResult

public ViewResult(java.lang.String mode,
                  java.lang.String input,
                  java.lang.String docContextID,
                  java.lang.String highlightInfo)

Method Detail

getResultType

public int getResultType()

Gets the result type.

Returns:

result type

getResult

public java.lang.String getResult()

Gets the result.

Returns:

result

getHighlightInfo

public java.lang.String getHighlightInfo()

returns highlight information

Returns:

getMode

public java.lang.String getMode()

returns mode

Returns:

getDocContextID

public java.lang.String getDocContextID()

setMode

public void setMode(java.lang.String pMode)

setInput

public void setInput(java.lang.String pInput)

setDocContextID

public void setDocContextID(java.lang.String pDocContextID)

setHighlightInfo

public void setHighlightInfo(java.lang.String pHighlightInfo)

setResultType

public void setResultType(int pResultType)

getInput

public java.lang.String getInput()

setResult

public void setResult(java.lang.String result)

getDocument

public com.primus.searchstudio.ResultDocument getDocument()

returns doc info when returnType is information

Returns:

setDocument

public void setDocument(com.primus.searchstudio.ResultDocument document)

sets the document

Parameters:

document -

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object