com.tridion.broker.querying.criteria.structuregroups

Class StructureGroupTitleCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

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

com.tridion.broker.querying.criteria.structuregroups.StructureGroupTitleCriteria

public class StructureGroupTitleCriteria
extends AbstractTaxonomyKeywordCriteria

This allows querying for items related to a specific structure group with a specific title.

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
StructureGroupTitleCriteria(String title) This constructs the structure group title criteria.
StructureGroupTitleCriteria(String title, FieldOperator operator) Constructs a StructureGroupTitleCriteria with applied operator, to restrict results to the specified structure group with a specified title.
StructureGroupTitleCriteria(String title, FieldOperator operator, boolean includeChildStructureGroups) Constructs a StructureGroupTitleCriteria with applied operator, to restrict results to the specified structure group with a specified title.

Method Summary

Modifier and Type	Method and Description
String	getStructureGroupTitle()
protected boolean	isLikeOperatorApplicable() Tests if like operator is applicable for the 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, toString

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

StructureGroupTitleCriteria

public StructureGroupTitleCriteria(String title)

This constructs the structure group title criteria.

Parameters:

title - The title of the structure group

StructureGroupTitleCriteria

public StructureGroupTitleCriteria(String title,
                                   FieldOperator operator)

Constructs a StructureGroupTitleCriteria with applied operator, to restrict results to the specified structure group with a specified title.

Parameters:

title - Title of the structure group.

operator - Operator to be applied to this criteria.

StructureGroupTitleCriteria

public StructureGroupTitleCriteria(String title,
                                   FieldOperator operator,
                                   boolean includeChildStructureGroups)

Constructs a StructureGroupTitleCriteria with applied operator, to restrict results to the specified structure group with a specified title.

Parameters:

title - Title 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

getStructureGroupTitle

public String getStructureGroupTitle()

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.