com.primus.searchstudio
Class Request

java.lang.Object
  com.primus.searchstudio.AbstractRequest
      com.primus.searchstudio.Request

All Implemented Interfaces:

java.io.Serializable

public final class Request
extends com.primus.searchstudio.AbstractRequest
implements java.io.Serializable

Search request value object.

See Also:

Serialized Form

Constructor Summary

Request(java.lang.String parsingOptions, java.lang.String question, java.util.Map optionalAttributes, boolean loggingEnabled, java.lang.String constraints, java.util.List userGroups, java.util.Map sortParameters)
Create a new search request.

Request(java.lang.String parsingOptions, java.lang.String question, java.util.Map optionalAttributes, boolean loggingEnabled, java.lang.String constraints, java.util.List userGroups, java.lang.String paConstraints, java.lang.String weightedProps, java.util.List priorInput)
Deprecated. As of Search 2006.3

Request(java.lang.String parsingOptions, java.lang.String question, java.util.Map optionalAttributes, boolean loggingEnabled, java.lang.String constraints, java.util.List userGroups, java.lang.String paConstraints, java.lang.String weightedProps, java.util.List priorInput, com.primus.searchstudio.ReportDataControl reportDataControl, com.primus.searchstudio.CustomResultRanking resultRanking, com.primus.searchstudio.CustomLogicTree logicTree)

Method Summary

boolean	getLoggingEnabled() Is logging enabled for this request?
com.primus.searchstudio.CustomLogicTree	getLogicTree() Gets custom query logic tree
java.util.Map	getOptionalAttributes() Gets the optionalAttributes property of this request.
java.util.Map	getOptionalAttributesRef() Return a reference to optionalAttributes
java.lang.String	getPaConstraints()
java.lang.String	getParsingOptions()
java.util.List	getPriorInput()
java.lang.String	getQuestion() Gets the question property of this request.
com.primus.searchstudio.ReportDataControl	getReportDataControl() Returns the ReportDataControl
java.lang.String	getRequestTag() gets the request tag
ConstantID	getRequestType() Gets the ConstantID request Type of this request, that is, the type of AbstractRequest
com.primus.searchstudio.CustomResultRanking	getResultRanking() returns the custom result ranking
java.lang.String	getSearchConstraints() Returns the XML presentation of Search constraints.
java.util.Map	getSortParameters()
java.lang.String[]	getTopics()
java.util.List	getUserGroups() Returns the array of Groips granted to user.
java.lang.String	getWeightedProperties()
boolean	isDebugEnabled()
void	setLoggingEnabled(boolean loggingEnabled)
void	setLogicTree(com.primus.searchstudio.CustomLogicTree logicTree) sets custom query logic tree
void	setPaConstraints(java.lang.String paConstraints)
void	setPriorInput(java.util.List priorInput)
void	setQuestion(java.lang.String question)
void	setReportDataControl(com.primus.searchstudio.ReportDataControl reportDataControl) sets report data control for controlling what kind of report data is returned in results
void	setResultRanking(com.primus.searchstudio.CustomResultRanking resultRanking) Sets custom result ranking algorithm
void	setSortParameters(java.util.Map sortParameters)
void	setUserGroups(java.util.List userGroups) Sets the array of groups granted to user.
void	setWeightedProperties(java.lang.String weightedProperties)
java.lang.String	toXML() Convert search request value object to its XML representation.

Methods inherited from class java.lang.Object

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

Constructor Detail

Request

public Request(java.lang.String parsingOptions,
               java.lang.String question,
               java.util.Map optionalAttributes,
               boolean loggingEnabled,
               java.lang.String constraints,
               java.util.List userGroups,
               java.util.Map sortParameters)
        throws java.lang.Exception

Create a new search request.

Parameters:

parsingOptions - general search options

question - query string

optionalAttributes - map of key/value pairs. Can include:

        exclusion
        debug
        responseNumberSettings
        documentSets
        

userGroups - a List of groups granted to user Note that for documentSets, if a value is not passed in, the value

Throws:

java.lang.Exception

Request

public Request(java.lang.String parsingOptions,
               java.lang.String question,
               java.util.Map optionalAttributes,
               boolean loggingEnabled,
               java.lang.String constraints,
               java.util.List userGroups,
               java.lang.String paConstraints,
               java.lang.String weightedProps,
               java.util.List priorInput)

Deprecated. As of Search 2006.3

Parameters:

parsingOptions -

question -

optionalAttributes -

loggingEnabled -

constraints -

userGroups -

paConstraints -

weightedProps -

priorInput -

Request

public Request(java.lang.String parsingOptions,
               java.lang.String question,
               java.util.Map optionalAttributes,
               boolean loggingEnabled,
               java.lang.String constraints,
               java.util.List userGroups,
               java.lang.String paConstraints,
               java.lang.String weightedProps,
               java.util.List priorInput,
               com.primus.searchstudio.ReportDataControl reportDataControl,
               com.primus.searchstudio.CustomResultRanking resultRanking,
               com.primus.searchstudio.CustomLogicTree logicTree)

Parameters:

parsingOptions -

question -

optionalAttributes -

loggingEnabled -

constraints -

userGroups -

paConstraints -

weightedProps -

priorInput -

reportDataControl -

resultRanking -

logicTree -

Method Detail

getReportDataControl

public com.primus.searchstudio.ReportDataControl getReportDataControl()

Returns the ReportDataControl

Returns:

setReportDataControl

public void setReportDataControl(com.primus.searchstudio.ReportDataControl reportDataControl)

sets report data control for controlling what kind of report data is returned in results

Parameters:

reportDataControl -

getResultRanking

public com.primus.searchstudio.CustomResultRanking getResultRanking()

returns the custom result ranking

Returns:

setResultRanking

public void setResultRanking(com.primus.searchstudio.CustomResultRanking resultRanking)

Sets custom result ranking algorithm

Parameters:

resultRanking -

getLogicTree

public com.primus.searchstudio.CustomLogicTree getLogicTree()

Gets custom query logic tree

Returns:

setLogicTree

public void setLogicTree(com.primus.searchstudio.CustomLogicTree logicTree)

sets custom query logic tree

Parameters:

logicTree -

getQuestion

public java.lang.String getQuestion()

Gets the question property of this request.

Specified by:

getQuestion in class com.primus.searchstudio.AbstractRequest

Returns:

question

setQuestion

public void setQuestion(java.lang.String question)

getRequestType

public ConstantID getRequestType()

Gets the ConstantID request Type of this request, that is, the type of AbstractRequest

Specified by:

getRequestType in class com.primus.searchstudio.AbstractRequest

Returns:

request type

getLoggingEnabled

public boolean getLoggingEnabled()

Is logging enabled for this request?

Specified by:

getLoggingEnabled in class com.primus.searchstudio.AbstractRequest

Returns:

loggingEnabled

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in class com.primus.searchstudio.AbstractRequest

setLoggingEnabled

public void setLoggingEnabled(boolean loggingEnabled)

getRequestTag

public java.lang.String getRequestTag()

gets the request tag

Specified by:

getRequestTag in class com.primus.searchstudio.AbstractRequest

Returns:

getOptionalAttributes

public java.util.Map getOptionalAttributes()

Gets the optionalAttributes property of this request. This returns a copy of the map, rather than a reference to the map itself. This is to preserve Request as an immutable object.

Returns:

copy of search attributes

getOptionalAttributesRef

public java.util.Map getOptionalAttributesRef()

Return a reference to optionalAttributes

Returns:

getUserGroups

public java.util.List getUserGroups()

Returns the array of Groips granted to user.

Returns:

a List of groups granted to user

setUserGroups

public void setUserGroups(java.util.List userGroups)

Sets the array of groups granted to user.

Parameters:

userGroups - a List of groups granted to user

getTopics

public java.lang.String[] getTopics()

Specified by:

getTopics in class com.primus.searchstudio.AbstractRequest

getSortParameters

public java.util.Map getSortParameters()

setSortParameters

public void setSortParameters(java.util.Map sortParameters)

getParsingOptions

public java.lang.String getParsingOptions()

toXML

public java.lang.String toXML()

Convert search request value object to its XML representation.

Specified by:

toXML in class com.primus.searchstudio.AbstractRequest

Returns:

XML string describing input argument

getSearchConstraints

public java.lang.String getSearchConstraints()

Returns the XML presentation of Search constraints.

Specified by:

getSearchConstraints in class com.primus.searchstudio.AbstractRequest

Returns:

a String value of document Sets XML element

getPaConstraints

public java.lang.String getPaConstraints()

setPaConstraints

public void setPaConstraints(java.lang.String paConstraints)

getWeightedProperties

public java.lang.String getWeightedProperties()

setWeightedProperties

public void setWeightedProperties(java.lang.String weightedProperties)

getPriorInput

public java.util.List getPriorInput()

setPriorInput

public void setPriorInput(java.util.List priorInput)