com.endeca.content.ene
Class ENEContentQuery

java.lang.Object
  com.endeca.content.ene.ENEContentQuery

All Implemented Interfaces:

ContentQuery

public class ENEContentQuery
extends java.lang.Object
implements ContentQuery

An object used for executing content queries.

Since:

1.0.0

Version:

1.0.0

See Also:

ENEContentManager.createQuery()

Method Summary

ContentResults	execute() Executes this query and returns content results.
com.endeca.navigation.ENEConnection	getENEConnection() The ENEConnection to be used when executing this query and any resulting sub-queries.
com.endeca.navigation.ENEQuery	getENEQuery() The primary ENEQuery to be used when executing this content query.
java.lang.String	getRuleZone() The rule zone to be used for resolving dynamic content.
void	setENEConnection(com.endeca.navigation.ENEConnection pENEConnection) Specifies the ENEConnection to be used when executing this query and any resulting sub-queries.
void	setENEQuery(com.endeca.navigation.ENEQuery pENEQuery) Specifies the primary ENEQuery to be used when executing this content query.
void	setRuleZone(java.lang.String pRuleZone) Specifies the rule zone to be used for resolving dynamic content.

Methods inherited from class java.lang.Object

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

Method Detail

execute

public ContentResults execute()
                       throws InvalidQueryException,
                              ContentException

Executes this query and returns content results.

Note that this method will always return an ENEContentResults object.

Specified by:

execute in interface ContentQuery

Returns:

content query results.

Throws:

InvalidQueryException - if this query is invalid.

ContentException - if a query error occurs.

setRuleZone

public void setRuleZone(java.lang.String pRuleZone)

Specifies the rule zone to be used for resolving dynamic content.

A rule zone must be specified or a content query will fail.

Specified by:

setRuleZone in interface ContentQuery

Parameters:

pRuleZone - the rule zone to be used for resolving dynamic content.

getRuleZone

public java.lang.String getRuleZone()

The rule zone to be used for resolving dynamic content.

Specified by:

getRuleZone in interface ContentQuery

Returns:

the rule zone to be used for resolving dynamic content.

setENEQuery

public void setENEQuery(com.endeca.navigation.ENEQuery pENEQuery)

Specifies the primary ENEQuery to be used when executing this content query. This ENEQuery is executed initially to trigger content rules, which may then contain sub-query directives for populating content sections.

Parameters:

pENEQuery - the primary ENEQuery to be used when executing this query.

getENEQuery

public com.endeca.navigation.ENEQuery getENEQuery()

The primary ENEQuery to be used when executing this content query.

Returns:

the primary ENEQuery to be used when executing this query.

setENEConnection

public void setENEConnection(com.endeca.navigation.ENEConnection pENEConnection)

Specifies the ENEConnection to be used when executing this query and any resulting sub-queries.

Parameters:

pENEConnection - the ENEConnection to be used when executing this query and any resulting sub-queries.

getENEConnection

public com.endeca.navigation.ENEConnection getENEConnection()

The ENEConnection to be used when executing this query and any resulting sub-queries.

Returns:

the ENEConnection to be used when executing this query and any resulting sub-queries.