Package com.evolveum.midpoint.prism.query.builder

Interface S_FilterEntry

All Known Subinterfaces:

S_FilterEntryOrEmpty

public interface S_FilterEntry

See the grammar in Javadoc for QueryBuilder.

Method Summary

Modifier and Type	Method	Description
S_FilterExit	all()
S_FilterEntryOrEmpty	block()
S_FilterEntryOrEmpty	exists(Object... components)
S_FilterExit	filter(ObjectFilter filter)
S_FilterExit	fullText(String... words)
S_FilterExit	id(long... identifiers)
S_FilterExit	id(String... identifiers)
S_FilterExit	isChildOf(PrismReferenceValue value)
S_FilterExit	isChildOf(String oid)
S_FilterExit	isDirectChildOf(PrismReferenceValue value)
S_FilterExit	isDirectChildOf(String oid)
S_FilterExit	isInScopeOf(PrismReferenceValue value, OrgFilter.Scope scope)
S_FilterExit	isInScopeOf(String oid, OrgFilter.Scope scope)
S_FilterExit	isParentOf(PrismReferenceValue value)
S_FilterExit	isParentOf(String oid)
S_FilterExit	isRoot()
S_ConditionEntry	item(ItemPath path)
S_ConditionEntry	item(ItemPath itemPath, ItemDefinition itemDefinition)
S_ConditionEntry	item(PrismContainerDefinition<?> containerDefinition, ItemPath itemPath)
S_ConditionEntry	item(PrismContainerDefinition containerDefinition, QName... names)
S_ConditionEntry	item(String... names)
S_ConditionEntry	item(QName... names)
S_MatchingRuleEntry	itemAs(PrismProperty<?> property)
S_ConditionEntry	itemWithDef(ItemDefinition itemDefinition, QName... names)
S_FilterExit	none()
S_FilterEntry	not()
default S_FilterEntryOrEmpty	ownedBy(Class<? extends Containerable> clazz)
S_FilterEntryOrEmpty	ownedBy(Class<? extends Containerable> clazz, ItemPath path)
default S_FilterEntryOrEmpty	ownedBy(Class<? extends Containerable> clazz, Object... path)
S_FilterExit	ownerId(long... identifiers)
S_FilterExit	ownerId(String... identifiers)
default S_FilterEntryOrEmpty	ref(ItemPath path)	Creates REF filter with no values - good when only the target filter is required.
default S_FilterEntryOrEmpty	ref(ItemPath path, QName targetType, QName relation)
S_FilterEntryOrEmpty	ref(ItemPath path, QName targetType, QName relation, String... oid)
default S_FilterEntryOrEmpty	referencedBy(@NotNull Class<? extends Containerable> clazz, @NotNull ItemPath path)	Shortcut to referencedBy(Class, ItemPath, QName) with null relation which is interpreted as "any".
S_FilterEntryOrEmpty	referencedBy(@NotNull Class<? extends Containerable> clazz, @NotNull ItemPath path, QName relation)	Creates `referencedBy` filter that matches if the queried object is referenced by other specified object or container.
S_FilterEntryOrEmpty	type(Class<? extends Containerable> type)
S_FilterEntryOrEmpty	type(QName type)
S_FilterExit	undefined()

Method Detail

not

S_FilterEntry not()

all

S_FilterExit all()

none

S_FilterExit none()

undefined

S_FilterExit undefined()

filter

S_FilterExit filter(ObjectFilter filter)

item

S_ConditionEntry item(QName... names)

item

S_ConditionEntry item(String... names)

item

S_ConditionEntry item(ItemPath path)

item

S_ConditionEntry item(ItemPath itemPath,
                      ItemDefinition itemDefinition)

itemWithDef

S_ConditionEntry itemWithDef(ItemDefinition itemDefinition,
                             QName... names)

item

S_ConditionEntry item(PrismContainerDefinition containerDefinition,
                      QName... names)

item

S_ConditionEntry item(PrismContainerDefinition<?> containerDefinition,
                      ItemPath itemPath)

itemAs

S_MatchingRuleEntry itemAs(PrismProperty<?> property)

id

S_FilterExit id(String... identifiers)

id

S_FilterExit id(long... identifiers)

ownerId

S_FilterExit ownerId(String... identifiers)

ownerId

S_FilterExit ownerId(long... identifiers)

isDirectChildOf

S_FilterExit isDirectChildOf(PrismReferenceValue value)

isChildOf

S_FilterExit isChildOf(PrismReferenceValue value)

isDirectChildOf

S_FilterExit isDirectChildOf(String oid)

isChildOf

S_FilterExit isChildOf(String oid)

isParentOf

S_FilterExit isParentOf(PrismReferenceValue value)

isParentOf

S_FilterExit isParentOf(String oid)

isInScopeOf

S_FilterExit isInScopeOf(String oid,
                         OrgFilter.Scope scope)

isInScopeOf

S_FilterExit isInScopeOf(PrismReferenceValue value,
                         OrgFilter.Scope scope)

isRoot

S_FilterExit isRoot()

fullText

S_FilterExit fullText(String... words)

block

S_FilterEntryOrEmpty block()

type

S_FilterEntryOrEmpty type(Class<? extends Containerable> type)

type

S_FilterEntryOrEmpty type(QName type)

exists

S_FilterEntryOrEmpty exists(Object... components)

ownedBy

default S_FilterEntryOrEmpty ownedBy(Class<? extends Containerable> clazz,
                                     Object... path)

ownedBy

S_FilterEntryOrEmpty ownedBy(Class<? extends Containerable> clazz,
                             ItemPath path)

ownedBy

default S_FilterEntryOrEmpty ownedBy(Class<? extends Containerable> clazz)

referencedBy

default S_FilterEntryOrEmpty referencedBy(@NotNull
                                          @NotNull Class<? extends Containerable> clazz,
                                          @NotNull
                                          @NotNull ItemPath path)

Shortcut to referencedBy(Class, ItemPath, QName) with null relation which is interpreted as "any". This is actually great for filtering where something not specified mostly implies "I don't care", but this is different from an existing REF filter, where null relation defaults to "default" relation. Eventually, REF filter should be changed to be more intuitive.

referencedBy

S_FilterEntryOrEmpty referencedBy(@NotNull
                                  @NotNull Class<? extends Containerable> clazz,
                                  @NotNull
                                  @NotNull ItemPath path,
                                  QName relation)

Creates `referencedBy` filter that matches if the queried object is referenced by other specified object or container. This is a "blocky" filter that allows for inner filter, applied to the referencing entity. For example: ---- // query for role referenced by user assignment, with inner filter applied to user .referencedBy(UserType.class, ItemPath.create(F_ASSIGNMENT, F_TARGET_REF)) .block() .not().item(UserType.F_COST_CENTER).isNull() .and() .item(UserType.F_POLICY_SITUATION).isNull() .endBlock() ----

Parameters:

clazz - type of the referenced object (can be an abstract type too)

path - item path of the reference

relation - optional relation of the incoming reference, null means it does not matter (any)

ref

default S_FilterEntryOrEmpty ref(ItemPath path)

Creates REF filter with no values - good when only the target filter is required. For example: ---- filter.ref(ObjectType.F_PARENT_ORG_REF) .item(OrgType.F_DISPLAY_ORDER).eq(30) // target filter ----

ref

default S_FilterEntryOrEmpty ref(ItemPath path,
                                 QName targetType,
                                 QName relation)

ref

S_FilterEntryOrEmpty ref(ItemPath path,
                         QName targetType,
                         QName relation,
                         String... oid)