com.tridion.broker.querying.criteria.publication

Class PublicationKeyCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

com.tridion.broker.querying.criteria.publication.PublicationKeyCriteria

public class PublicationKeyCriteria
extends Criteria

This enables the broker query engine to retrieve content for a publication key.
Examples:

• PublicationKeyCriteria criteria = new PublicationKeyCriteria("some pub. key") will match all items from publication with key "some pub. key".

Field Summary

Fields inherited from class com.tridion.broker.querying.criteria.Criteria

EQUAL, GREATER_OR_EQUAL_THAN, GREATER_THAN, LESS_OR_EQUAL_THAN, LESS_THAN, LIKE, NOT_EQUAL

Constructor Summary

Constructors

Constructor and Description
PublicationKeyCriteria(String publicationKey) This constructs the PublicationKeyCriteria with a specific PublicationKey.
PublicationKeyCriteria(String publicationKey, FieldOperator operator) This constructs the PublicationKeyCriteria with a specific publicationKey and a specific field operator.

Method Summary

Modifier and Type	Method and Description
String	getPublicationKey() This returns the publicationKey to use as the Criteria.
protected boolean	isLikeOperatorApplicable() Like operator is applicable to this criteria.
String	toString() Returns string presentation of the criteria.

Methods inherited from class com.tridion.broker.querying.criteria.Criteria

addCriteria, getCriteriaChildren, getCriteriaName, getFieldOperatorAsString, getParentOperator, getSignature, hasAnyCriteria, isOperator, setParentOperator

Methods inherited from class java.lang.Object

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

Constructor Detail

PublicationKeyCriteria

public PublicationKeyCriteria(String publicationKey)

This constructs the PublicationKeyCriteria with a specific PublicationKey.

Parameters:

publicationKey - The publicationKey to query for

PublicationKeyCriteria

public PublicationKeyCriteria(String publicationKey,
                              FieldOperator operator)

This constructs the PublicationKeyCriteria with a specific publicationKey and a specific field operator.

Parameters:

publicationKey - - The publicationKey to query for.

operator - - Operator for the queried title id (Criteria.EQUAL, Criteria.GREATER_THAN, ...).

Method Detail

getPublicationKey

public String getPublicationKey()

This returns the publicationKey to use as the Criteria.

Returns:

The publicationKey to use as the Criteria

toString

public String toString()

Returns string presentation of the criteria.

Overrides:

toString in class Criteria

Returns:

String presentation of criteria

isLikeOperatorApplicable

protected boolean isLikeOperatorApplicable()

Like operator is applicable to this criteria.

Overrides:

isLikeOperatorApplicable in class Criteria

Returns:

if the like operator is applicable. By default it is not applicable. This method should be overided by criteria classes.