com.primus.searchstudio
Class CategoryRequest

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

All Implemented Interfaces:

java.io.Serializable

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

Search request value object.

See Also:

Serialized Form

Constructor Summary

CategoryRequest(CategoryRequestOptions categoryRequestOptions, java.lang.String query, java.lang.String constraints, java.util.List userGroups, boolean loggingEnabled, boolean isTopQ)

CategoryRequest(CategoryRequestOptions categoryRequestOptions, java.lang.String query, java.lang.String constraints, java.lang.String parserOptions, java.util.List userGroups, boolean loggingEnabled, boolean isTopQ)

Method Summary

CategoryRequestOptions	getCategoryRequestOptions() Gets the question property of this request.
java.lang.String	getGroupMode() Meaningless for categories.
boolean	getLoggingEnabled() Is logging enabled for this request?
java.lang.String	getParsingOptions() Returns parser options xml
java.lang.String	getQuery() Gets the query input.
java.lang.String	getQuestion() There is no question for this type of request
java.lang.String	getRequestTag() no request tag
ConstantID	getRequestType() Return the request type.
java.lang.String	getSearchConstraints()
java.lang.String[]	getTopics()
java.util.List	getUserGroups() Returns the array of Groups granted to user.
boolean	isDebugEnabled()
boolean	isTopQ() Is skip logging for this request?
void	setParsingOptions(java.lang.String pParserOptions) Sets parser options xml
void	setUserGroups(java.util.List userGroups) Sets the array of groups granted to user.
java.lang.String	toString() Standard toString function.
java.lang.String	toXML()

Methods inherited from class java.lang.Object

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

Constructor Detail

CategoryRequest

public CategoryRequest(CategoryRequestOptions categoryRequestOptions,
                       java.lang.String query,
                       java.lang.String constraints,
                       java.util.List userGroups,
                       boolean loggingEnabled,
                       boolean isTopQ)

Parameters:

categoryRequestOptions -

query -

constraints -

userGroups -

loggingEnabled -

isTopQ -

CategoryRequest

public CategoryRequest(CategoryRequestOptions categoryRequestOptions,
                       java.lang.String query,
                       java.lang.String constraints,
                       java.lang.String parserOptions,
                       java.util.List userGroups,
                       boolean loggingEnabled,
                       boolean isTopQ)

Parameters:

categoryRequestOptions -

query -

constraints -

parserOptions - parser options xml

userGroups -

loggingEnabled -

isTopQ -

Method Detail

getParsingOptions

public java.lang.String getParsingOptions()

Returns parser options xml

Returns:

parser options xml

setParsingOptions

public void setParsingOptions(java.lang.String pParserOptions)

Sets parser options xml

Parameters:

pParserOptions - parser options xml

getRequestTag

public java.lang.String getRequestTag()

no request tag

Specified by:

getRequestTag in class com.primus.searchstudio.AbstractRequest

Returns:

getQuestion

public java.lang.String getQuestion()

There is no question for this type of request

Specified by:

getQuestion in class com.primus.searchstudio.AbstractRequest

Returns:

empty String

getCategoryRequestOptions

public CategoryRequestOptions getCategoryRequestOptions()

Gets the question property of this request.

Returns:

question

getQuery

public java.lang.String getQuery()

Gets the query input.

Returns:

query input

getRequestType

public ConstantID getRequestType()

Return the request type.

Specified by:

getRequestType in class com.primus.searchstudio.AbstractRequest

getUserGroups

public java.util.List getUserGroups()

Returns the array of Groups 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

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

getSearchConstraints

public java.lang.String getSearchConstraints()

Specified by:

getSearchConstraints in class com.primus.searchstudio.AbstractRequest

toXML

public java.lang.String toXML()

Specified by:

toXML in class com.primus.searchstudio.AbstractRequest

isTopQ

public boolean isTopQ()

Is skip logging for this request?

Returns:

loggingEnabled

getGroupMode

public java.lang.String getGroupMode()

Meaningless for categories.

Returns:

-1

toString

public java.lang.String toString()

Standard toString function.

Overrides:

toString in class java.lang.Object