atg.search.query.messages
Class SearchMessage

java.lang.Object
  atg.search.query.messages.SearchMessage

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BrowseMessage, CategorizeMessage, QueryMessage, SimilarDocsMessage, StructuredQueryMessage, ViewInContextMessage

public abstract class SearchMessage
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION

Constructor Summary

protected

SearchMessage(ClientRequest pClientRequest) Create a search message

Method Summary

protected ClientRequest	getClientRequest() Get the request as the base type request
abstract java.lang.String	getJMSType() Get the JMS type
java.lang.String	getOpitonSetName() Get the option set name used in the search or null if the default option set was used.
int	getResultCount() Return the number of results.
Results	getResults() Return the results object.
java.lang.String	getSiteName() Get the site name
RepositoryItem	getUserProfile() Return the user profile for the user issuing this query
protected int	parseInt(java.lang.String pValue, int pDefault) Parse an string int value
void	setOptionSetName(java.lang.String pOptionSetName) Set the option set name used in the search
void	setResults(Results pResults) Set the search results object
void	setSiteName(java.lang.String pSiteName) Set the siteName value
void	setUserProfile(RepositoryItem pUserProfile) Set the user profile for the user issuing this query

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Constructor Detail

SearchMessage

protected SearchMessage(ClientRequest pClientRequest)

Create a search message

Parameters:

pJMSType - a string identifying the JMS message type

pRequest - the search request

Method Detail

getJMSType

public abstract java.lang.String getJMSType()

Get the JMS type

Returns:

the JMS type

setSiteName

public void setSiteName(java.lang.String pSiteName)

Set the siteName value

Parameters:

pSiteName - the site name

getSiteName

public java.lang.String getSiteName()

Get the site name

Returns:

the site name

setOptionSetName

public void setOptionSetName(java.lang.String pOptionSetName)

Set the option set name used in the search

Parameters:

pOptionSetName - the option set name

getOpitonSetName

public java.lang.String getOpitonSetName()

Get the option set name used in the search or null if the default option set was used.

Parameters:

pOptionSetName - the option set name

setUserProfile

public void setUserProfile(RepositoryItem pUserProfile)

Set the user profile for the user issuing this query

Parameters:

pUserProfile - the user profile

getUserProfile

public RepositoryItem getUserProfile()

Return the user profile for the user issuing this query

Returns:

the user profile or null

getResults

public Results getResults()

Return the results object. This is the object returned from the query

Returns:

the query result object

setResults

public void setResults(Results pResults)

Set the search results object

Parameters:

pResults - the search results object

getResultCount

public int getResultCount()

Return the number of results. This is just a top-level property for the Results.groupCount property.

Returns:

the result count

getClientRequest

protected ClientRequest getClientRequest()

Get the request as the base type request

Returns:

the search request

parseInt

protected int parseInt(java.lang.String pValue,
                       int pDefault)

Parse an string int value

Parameters:

pValue - int value as string to parse

pDefault - default value if string is empty or invalid