com.tridion.smarttarget.query.builder

Class PageCriteria

java.lang.Object

com.tridion.smarttarget.query.builder.ParameterCriteria

com.tridion.smarttarget.query.builder.ScopeCriteria

com.tridion.smarttarget.query.builder.PageCriteria

All Implemented Interfaces:

com.tridion.smarttarget.query.builder.Criteria

public final class PageCriteria
extends ScopeCriteria

Criteria used to Scope result by specifying a Page.

Field Summary

Fields inherited from class com.tridion.smarttarget.query.builder.ParameterCriteria

TEMPLATE

Constructor Summary

Constructors

Constructor and Description
PageCriteria(com.tridion.smarttarget.utils.TcmUri pageId) Creates a Page based Criteria.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getParameterName() Gets the name of the ParameterCriteria.
String	getParameterValue() Gets the value of the ParameterCriteria.
int	hashCode()
String	toString()
List<Object>	visitCriteria(List<Object> criteriaList)

Methods inherited from class com.tridion.smarttarget.query.builder.ParameterCriteria

getParameter

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PageCriteria

public PageCriteria(com.tridion.smarttarget.utils.TcmUri pageId)
             throws com.tridion.smarttarget.SmartTargetException

Creates a Page based Criteria.

Parameters:

pageId - the Id of the Page.

Throws:

com.tridion.smarttarget.SmartTargetException - thrown if the page is null or not a Page.

Method Detail

getParameterName

public String getParameterName()

Description copied from class: ParameterCriteria

Gets the name of the ParameterCriteria.

Specified by:

getParameterName in class ParameterCriteria

Returns:

the name of the ParameterCriteria.

getParameterValue

public String getParameterValue()

Gets the value of the ParameterCriteria.

Overrides:

getParameterValue in class ScopeCriteria

Returns:

the value of the ParameterCriteria.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

visitCriteria

public List<Object> visitCriteria(List<Object> criteriaList)

Specified by:

visitCriteria in interface com.tridion.smarttarget.query.builder.Criteria

Overrides:

visitCriteria in class ParameterCriteria