com.beasys.commerce.axiom.p13n.agents
Interface ContentQueryAdviceRequest

All Known Subinterfaces:

ContentSelectorAdviceRequest

All Known Implementing Classes:

ContentQueryAdviceRequestImpl

Deprecated. As of WLPS 3.1, replaced by ContentQueryAdviceRequest

public interface ContentQueryAdviceRequest

extends AdviceRequest

This is a concrete interface that represents the interface for a content query (search) request for content. It contains all of the common request data required by a content search engine.

Method Summary

java.lang.String	getContentHome() Deprecated. Gets the content ejb home JNDI name for the content manager to use for the content query request.
long	getMax() Deprecated. Gets the maximum number of content items to return from a content query request.
java.lang.String	getQuery() Deprecated. Gets the content query string used to search for content.
java.lang.String	getSortBy() Deprecated. Gets the sort string used that is used to sort the content items returned from the content query request.
void	setContentHome(java.lang.String contentHome) Deprecated. Sets the content ejb home JNDI name for the content manager to use for the content query request.
void	setMax(long max) Deprecated. Sets the maximum number of content items to return from a content query request.
void	setQuery(java.lang.String query) Deprecated. Sets the content query string used to search for content.
void	setSortBy(java.lang.String sortBy) Deprecated. Sets the sort string used that is used to sort the content items returned from the content query request.

Methods inherited from interface com.beasys.commerce.axiom.p13n.advisor.AdviceRequest

getAgent, validate

Method Detail

getMax

public long getMax()

Deprecated.

Gets the maximum number of content items to return from a content query request.

Returns:

long The maximum number of content items to return.

setMax

public void setMax(long max)

Deprecated.

Sets the maximum number of content items to return from a content query request.

Parameters:

max - The maximum number of content items to return.

getSortBy

public java.lang.String getSortBy()

Deprecated.

Gets the sort string used that is used to sort the content items returned from the content query request. It is list of document attributes to sort the content by. The syntax follows the SQL 'order by' clause. The sort specification is limited to a list of the metadata attribute names and the keywords ASC and DESC. Examples: sortBy="creationDate" sortBy="creationDate ASC, title DESC"

Returns:

String The sortBy string.

setSortBy

public void setSortBy(java.lang.String sortBy)

Deprecated.

Sets the sort string used that is used to sort the content items returned from the content query request. It is list of document attributes to sort the content by. The syntax follows the SQL 'order by' clause. The sort specification is limited to a list of the metadata attribute names and the keywords ASC and DESC. Examples: sortBy="creationDate" sortBy="creationDate ASC, title DESC"

Parameters:

sortBy - The sortBy string.

getContentHome

public java.lang.String getContentHome()

Deprecated.

Gets the content ejb home JNDI name for the content manager to use for the content query request.

Returns:

String The content ejb home JNDI name.

setContentHome

public void setContentHome(java.lang.String contentHome)

Deprecated.

Sets the content ejb home JNDI name for the content manager to use for the content query request.

Parameters:

String - The content ejb home JNDI name.

getQuery

public java.lang.String getQuery()

Deprecated.

Gets the content query string used to search for content. Example: query="mimetype contains 'text' AND author='Proulx'"

Returns:

String The query string.

setQuery

public void setQuery(java.lang.String query)

Deprecated.

Sets the content query string used to search for content. Example: query="mimetype contains 'text' AND author='Proulx'"

Returns:

String The query string.