com.beasys.commerce.axiom.p13n.agents
Class ContentSelectorAdviceRequestImpl

java.lang.Object
  |
  +--com.beasys.commerce.axiom.p13n.advisor.AbstractAdviceRequestImpl
        |
        +--com.beasys.commerce.axiom.p13n.agents.ContentSelectorAdviceRequestImpl

Deprecated. As of WLPS 3.1, replaced by ContentSelectorAdviceRequestImpl

public class ContentSelectorAdviceRequestImpl

extends AbstractAdviceRequestImpl

implements ContentSelectorAdviceRequest, java.io.Serializable

This is a concrete class implementation for a ContentSelector advice request. Note, all Advice Request classes must be Serializable. Make sure that all data in this object are Serializable.

See Also:

Serialized Form

Field Summary

protected java.lang.String	contentHome Deprecated.
protected long	max Deprecated.
protected java.sql.Timestamp	now Deprecated.
protected java.lang.String	query Deprecated.
protected Request	request Deprecated.
protected java.lang.String	rule Deprecated.
protected java.lang.String	ruleSheet Deprecated.
protected Session	session Deprecated.
protected java.lang.String	sortBy Deprecated.
protected ConfigurableEntity	successor Deprecated.
protected ConfigurableEntity	user Deprecated.

Fields inherited from class com.beasys.commerce.axiom.p13n.advisor.AbstractAdviceRequestImpl

agent

Constructor Summary

ContentSelectorAdviceRequestImpl(Agent agent)
Deprecated. Creates a new instance of a ContentSelectorAdviceRequest object.

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.
Request	getHttpRequest() Deprecated. Returns the com.beasys.commerce.axiom.p13n.http.Request object for this request.
Session	getHttpSession() Deprecated. Returns the com.beasys.commerce.axiom.p13n.http.Session object for this request.
long	getMax() Deprecated. Gets the maximum number of content items to return from a content query request.
java.sql.Timestamp	getNow() Deprecated. Returns the Now object for this request.
java.lang.String	getQuery() Deprecated. Gets the content query string used to search for content.
java.lang.String	getRule() Deprecated. Returns the name of the rule associated with the requset.
java.lang.String	getRuleSheet() Deprecated. Returns the name of the rule sheet associated with the request.
java.lang.String	getSortBy() Deprecated. Gets the sort string used that is used to sort the content items returned from the content query request.
ConfigurableEntity	getSuccessor() Deprecated. Returns the Successor object for this user for this request.
ConfigurableEntity	getUser() Deprecated. Returns the user ConfigurableEntity object.
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	setHttpRequest(Request request) Deprecated. Sets the com.beasys.commerce.axiom.p13n.http.Request object for this request.
void	setHttpSession(Session session) Deprecated. Sets the com.beasys.commerce.axiom.p13n.http.Session object for this request.
void	setMax(long max) Deprecated. Sets the maximum number of content items to return from a content query request.
void	setNow(java.sql.Timestamp now) Deprecated. Sets the Now object for this request.
void	setQuery(java.lang.String query) Deprecated. Sets the content query string used to search for content.
void	setRule(java.lang.String rule) Deprecated. Sets the name of the rule associated with the request.
void	setRuleSheet(java.lang.String ruleSheet) Deprecated. Sets the name of the rule sheet associated with the request.
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.
void	setSuccessor(ConfigurableEntity successor) Deprecated. Sets the Successor object for this user for this request.
void	setUser(ConfigurableEntity user) Deprecated. Sets the user ConfigurableEntity object for this request.
void	validate() Deprecated. Validates the request.

Methods inherited from class com.beasys.commerce.axiom.p13n.advisor.AbstractAdviceRequestImpl

getAgent

Methods inherited from class java.lang.Object

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

Field Detail

ruleSheet

protected java.lang.String ruleSheet

Deprecated.

rule

protected java.lang.String rule

Deprecated.

user

protected ConfigurableEntity user

Deprecated.

successor

protected ConfigurableEntity successor

Deprecated.

now

protected java.sql.Timestamp now

Deprecated.

request

protected Request request

Deprecated.

session

protected Session session

Deprecated.

max

protected long max

Deprecated.

sortBy

protected java.lang.String sortBy

Deprecated.

contentHome

protected java.lang.String contentHome

Deprecated.

query

protected java.lang.String query

Deprecated.

Constructor Detail

ContentSelectorAdviceRequestImpl

public ContentSelectorAdviceRequestImpl(Agent agent)

Deprecated.

Creates a new instance of a ContentSelectorAdviceRequest object. This method is meant to be called by the Personalization Advisor which acts as a factory for all AdviceRequest objects.

Parameters:

agent - The default personalization agent to use for making recommendations.

Method Detail

getRuleSheet

public java.lang.String getRuleSheet()

Deprecated.

Returns the name of the rule sheet associated with the request.

Returns:

String The rule sheet associated with this request.

setRuleSheet

public void setRuleSheet(java.lang.String ruleSheet)

Deprecated.

Sets the name of the rule sheet associated with the request.

Parameters:

String - The rule sheet associated with this request.

getRule

public java.lang.String getRule()

Deprecated.

Returns the name of the rule associated with the requset.

Returns:

String The rule associated with this request.

setRule

public void setRule(java.lang.String rule)

Deprecated.

Sets the name of the rule associated with the request.

Parameters:

String - The rule associated with this request.

getUser

public ConfigurableEntity getUser()

Deprecated.

Returns the user ConfigurableEntity object.

Returns:

User The User object.

setUser

public void setUser(ConfigurableEntity user)

Deprecated.

Sets the user ConfigurableEntity object for this request.

Parameters:

user - The User object for this request.

getSuccessor

public ConfigurableEntity getSuccessor()

Deprecated.

Returns the Successor object for this user for this request.

Returns:

ConfigurableEntity The successor object.

setSuccessor

public void setSuccessor(ConfigurableEntity successor)

Deprecated.

Sets the Successor object for this user for this request.

Parameters:

successor - The successor object for this user for this request.

getNow

public java.sql.Timestamp getNow()

Deprecated.

Returns the Now object for this request.

Returns:

java.sql.Timestamp The Now object.

setNow

public void setNow(java.sql.Timestamp now)

Deprecated.

Sets the Now object for this request.

Parameters:

now - The java.sql.Timestamp object for this request.

getHttpRequest

public Request getHttpRequest()

Deprecated.

Returns the com.beasys.commerce.axiom.p13n.http.Request object for this request.

Returns:

com.beasys.commerce.axiom.p13n.http.Request The request object.

setHttpRequest

public void setHttpRequest(Request request)

Deprecated.

Sets the com.beasys.commerce.axiom.p13n.http.Request object for this request.

Parameters:

now - The com.beasys.commerce.axiom.p13n.http.Request object for this request.

getHttpSession

public Session getHttpSession()

Deprecated.

Returns the com.beasys.commerce.axiom.p13n.http.Session object for this request.

Returns:

com.beasys.commerce.axiom.p13n.http.Session The request object.

setHttpSession

public void setHttpSession(Session session)

Deprecated.

Sets the com.beasys.commerce.axiom.p13n.http.Session object for this request.

Parameters:

now - The com.beasys.commerce.axiom.p13n.http.Session object for this request.

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.

validate

public void validate()
              throws AdviceRequestValidationException

Deprecated.

Validates the request. A ContentSelectorAdviceRequest must have the following data in the request: ruleSheet - the URI string name of the rulesheet rule name - a string name of a rule input objects which include: - java.sql.Timestamp object for NOW - com.beasys.commerce.axiom.contact.User - com.beasys.commerce.axiom.p13n.agents.Successor (optional) - com.beasys.commerce.axiom.p13n.http.Request - com.beasys.commerce.axiom.p13n.http.Session max - the maximum number of content items to return. sortBy - the sort by sting. (optional) contentHome - the JNDI name of the content manager home. query - the query string.

Overrides:

validate in class AbstractAdviceRequestImpl

Throws:

AdviceRequestValidationException - thrown when not valid. The message in the exception indicates the validation error.