com.tridion.broker.querying.criteria.structuregroups

Class StructureGroupCriteria

java.lang.Object

com.tridion.broker.querying.criteria.Criteria

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

com.tridion.broker.querying.criteria.structuregroups.StructureGroupCriteria

public class StructureGroupCriteria
extends AbstractTaxonomyKeywordCriteria

This will make sure the items returned are only returned if there is a relation with the specified 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
StructureGroupCriteria(String structureGroupURI) Constructs a StructureGroupCriteria, to restrict results to the specified StructureGroup.
StructureGroupCriteria(String structureGroupURI, boolean includeChildStructureGroups) Constructs a StructureGroupCriteria, to restrict results to the specified StructureGroup.

Method Summary

Modifier and Type	Method and Description
String	getStructureGroupURI()
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, isLikeOperatorApplicable, 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

StructureGroupCriteria

public StructureGroupCriteria(String structureGroupURI)

Constructs a StructureGroupCriteria, to restrict results to the specified StructureGroup.

Parameters:

structureGroupURI - The URI of the structure group.

StructureGroupCriteria

public StructureGroupCriteria(String structureGroupURI,
                              boolean includeChildStructureGroups)

Constructs a StructureGroupCriteria, to restrict results to the specified StructureGroup.

Parameters:

structureGroupURI - The URI of the structure group.

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

Method Detail

toString

public String toString()

Return a String representation of this Criteria.

Overrides:

toString in class Criteria

getStructureGroupURI

public String getStructureGroupURI()