com.tridion.broker.querying.criteria.structuregroups

Class StructureGroupDirectoryCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

com.tridion.broker.querying.criteria.taxonomy.AbstractTaxonomyKeywordCriteria

com.tridion.broker.querying.criteria.structuregroups.StructureGroupDirectoryCriteria

public class StructureGroupDirectoryCriteria
extends AbstractTaxonomyKeywordCriteria

This will make sure the items returned are only returned if there is a relation with the specified directory of a StructureGroup.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CRITERIA_NAME Criteria name.

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
StructureGroupDirectoryCriteria(String directory) Constructs a StructureGroupDirectoryCriteria, to restrict results to the specified structure group with a specified directory.
StructureGroupDirectoryCriteria(String directory, FieldOperator operator) Constructs a StructureGroupDirectoryCriteria with applied operator, to restrict results to the specified structure group with a specified directory.
StructureGroupDirectoryCriteria(String directory, FieldOperator operator, boolean includeChildStructureGroups) Constructs a StructureGroupDirectoryCriteria with applied operator, to restrict results to the specified Structuregroup with a specified directory.

Method Summary

Modifier and Type	Method and Description
String	getStructureGroupDirectory()
protected boolean	isLikeOperatorApplicable() Tests if like operator is applicable for the criteria.
String	toString() Return a String representation of this Criteria.

Methods inherited from class com.tridion.broker.querying.criteria.taxonomy.AbstractTaxonomyKeywordCriteria

isIncludeKeywordBranches

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

Field Detail

CRITERIA_NAME

public static final String CRITERIA_NAME

Criteria name.

See Also:

Constant Field Values

Constructor Detail

StructureGroupDirectoryCriteria

public StructureGroupDirectoryCriteria(String directory)

Constructs a StructureGroupDirectoryCriteria, to restrict results to the specified structure group with a specified directory.

Parameters:

directory - the name of the directory

StructureGroupDirectoryCriteria

public StructureGroupDirectoryCriteria(String directory,
                                       FieldOperator operator)

Constructs a StructureGroupDirectoryCriteria with applied operator, to restrict results to the specified structure group with a specified directory.

Parameters:

directory - Directory of the structure group.

operator - Operator to be applied to this criteria.

StructureGroupDirectoryCriteria

public StructureGroupDirectoryCriteria(String directory,
                                       FieldOperator operator,
                                       boolean includeChildStructureGroups)

Constructs a StructureGroupDirectoryCriteria with applied operator, to restrict results to the specified Structuregroup with a specified directory.

Parameters:

directory - Directory of the structure group.

operator - Operator applied to criteria.

includeChildStructureGroups - This flag if true allows to get all the items which belong to structure group children.

Method Detail

getStructureGroupDirectory

public String getStructureGroupDirectory()

toString

public String toString()

Return a String representation of this Criteria.

Overrides:

toString in class Criteria

isLikeOperatorApplicable

protected boolean isLikeOperatorApplicable()

Description copied from class: Criteria

Tests if like operator is applicable for the 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.