Package com.evolveum.midpoint.schema.processor

Interface ShadowReferenceAttributeDefinition

All Superinterfaces:

Cloneable, DebugDumpable, Definition, Freezable, ItemDefinition<PrismContainer<ShadowAssociationValueType>>, LayeredDefinition, LivePrismItemDefinition, LocalItemDefinitionStore, PrismContainerDefinition<ShadowAssociationValueType>, PrismItemAccessDefinition, PrismItemBasicDefinition, PrismItemMiscDefinition, PrismItemStorageDefinition, PrismLifecycleDefinition, PrismPresentationDefinition, ResourceObjectInboundDefinition.ItemInboundDefinition, Revivable, Serializable, ShadowAttributeDefinition<ShadowReferenceAttribute,ShadowAssociationValueType>, ShadowItemLayeredDefinition, ShadowItemUcfDefinition, ShortDumpable, SmartVisitable<Definition>, Visitable<Definition>

All Known Implementing Classes:

ShadowReferenceAttributeDefinitionImpl

public interface ShadowReferenceAttributeDefinition
extends PrismContainerDefinition<ShadowAssociationValueType>, ShadowAttributeDefinition<ShadowReferenceAttribute,ShadowAssociationValueType>

Definition of an association item, e.g., `ri:group`. The association can be native or simulated; it can point right to the target object (like `group` object class), or to an intermediate - a.k.a. "associated" - one (like `groupMembership` object class).

See Also:

• ShadowAttributeDefinition

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.Definition

Definition.DefinitionBuilder, Definition.DefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.ItemDefinition

ItemDefinition.ItemDefinitionLikeBuilder, ItemDefinition.ItemDefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition

PrismContainerDefinition.PrismContainerDefinitionMutator<C extends Containerable>

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition

PrismItemAccessDefinition.Data, PrismItemAccessDefinition.Delegable, PrismItemAccessDefinition.Info, PrismItemAccessDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition

PrismItemBasicDefinition.Data, PrismItemBasicDefinition.Delegable, PrismItemBasicDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemMiscDefinition

PrismItemMiscDefinition.Data, PrismItemMiscDefinition.Delegable, PrismItemMiscDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition

PrismItemStorageDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition

PrismLifecycleDefinition.Data, PrismLifecycleDefinition.Delegable, PrismLifecycleDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition

PrismPresentationDefinition.Data, PrismPresentationDefinition.Delegable, PrismPresentationDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.schema.processor.ShadowItemUcfDefinition

ShadowItemUcfDefinition.Data, ShadowItemUcfDefinition.Delegable, ShadowItemUcfDefinition.Mutable

Field Summary

Fields

Modifier and Type	Field	Description
static final ItemName	VALUE

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
@NotNull ShadowReferenceAttributeDefinition	clone()
ContainerDelta<ShadowAssociationValueType>	createEmptyDelta()
ObjectFilter	createTargetObjectsFilter()	Creates a filter that provides all shadows eligible as the target value for this association.
@Nullable ShadowAssociationDefinitionType	getAssociationDefinitionBean()
default @NotNull AssociationParticipantType	getAssociationObjectInformation()	This is used for associations with the association object.
@Nullable ShadowAssociationTypeDefinitionType	getAssociationTypeDefinitionBean()
default @NotNull ResourceObjectClassDefinition	getImmediateTargetObjectClass()	Returns the object class definition of the immediate target object.
@NotNull Collection<AssociationParticipantType>	getImmediateTargetParticipantTypes()	Returns "immediate neighbors".
default Set<AssociationParticipantType>	getObjectDefinitionsFor(@NotNull ItemName refAttrName, @NotNull CompleteResourceSchema resourceSchema)
default @NotNull com.google.common.collect.Multimap<QName,AssociationParticipantType>	getObjectParticipants(@NotNull CompleteResourceSchema resourceSchema)	TEMPORARY
ResourceObjectDefinition	getRepresentativeTargetObjectDefinition()	TODO reconsider this: which definition should we provide as the representative one? There can be many.
default String	getResourceOid()
SimulatedShadowReferenceTypeDefinition	getSimulationDefinition()
SimulatedShadowReferenceTypeDefinition	getSimulationDefinitionRequired()
default boolean	hasAssociationObject()
default boolean	hasModernOutbound()
ShadowAssociationValue	instantiateFromIdentifierRealValue(@NotNull QName identifierName, @NotNull Object realValue)
boolean	isEntitlement()
default boolean	matches(@NotNull ShadowType potentialTarget)

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

debugDump, debugDump, debugDumpLazily, debugDumpLazily

Methods inherited from interface com.evolveum.midpoint.prism.Definition

checkMutableOnExposing, debugDump, getAnnotation, getAnnotations, getMergerIdentifier, getMergerInstance, getMutabilityFlag, getNaturalKeyConstituents, getNaturalKeyInstance, getSchemaContextDefinition, getTypeName, isAbstract, isElaborate, isOptionalCleanup, isRuntimeSchema

Methods inherited from interface com.evolveum.midpoint.prism.Freezable

checkImmutable, checkMutable, freeze, isImmutable

Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinition

cloneWithNewName, debugDumpShortToString, deepClone, getProcessing, getSubstitutionHead, getValueEnumerationRef, instantiate, instantiate, isAlwaysUseForEquals, isDynamic, isHeterogeneousListItem, isIgnored, isInherited, isOperational

Methods inherited from interface com.evolveum.midpoint.schema.processor.LayeredDefinition

getCurrentLayer

Methods inherited from interface com.evolveum.midpoint.prism.LivePrismItemDefinition

findItemDefinition, isValidFor

Methods inherited from interface com.evolveum.midpoint.prism.LocalItemDefinitionStore

containsItemDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition, findReferenceDefinition

Methods inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition

canRepresent, cloneWithNewDefinition, cloneWithNewType, createEmptyDelta, createValue, getAlwaysUseForEquals, getCompileTimeClass, getComplexTypeDefinition, getDefinitions, getItemNames, getPropertyDefinitions, getTypeClass, isAlwaysUseForEquals, isCompletelyDefined, isEmpty, mutator, replaceDefinition, structuredType

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition

canAdd, canModify, canRead, getInfo

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition

getItemName, getMaxOccurs, getMinOccurs, getTypeName, isMandatory, isMultiValue, isOptional, isSingleValue

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemMiscDefinition

getProcessing

Methods inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition

isIndexed, isIndexOnly, isSearchable

Methods inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition

getDeprecatedSince, getPlannedRemoval, getRemovedSince, getSchemaMigrations, isDeprecated, isExperimental, isRemoved

Methods inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition

getDiagrams, getDisplayHint, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, isEmphasized

Methods inherited from interface com.evolveum.midpoint.schema.processor.ResourceObjectInboundDefinition.ItemInboundDefinition

getCorrelatorDefinition

Methods inherited from interface com.evolveum.midpoint.prism.Revivable

revive

Methods inherited from interface com.evolveum.midpoint.schema.processor.ShadowAttributeDefinition

debugDump, forLayer, getChangeApplicationMode, getDescription, getFetchStrategy, getHumanReadableDescription, getInboundMappingBeans, getIntolerantValuePatterns, getLifecycleState, getModificationPriority, getOutboundMappingBean, getReadReplaceMode, getRelevantInboundDefinitions, getStandardPath, getStorageStrategy, getTolerantValuePatterns, getTypeClass, hasInboundMapping, hasOutboundMapping, hasRefinements, instantiate, instantiate, isCached, isEffectivelyCached, isExclusiveStrong, isIgnored, isIndexOnly, isReturnedByDefault, isSimulated, isTolerant, isVisible, isVisible, isVolatilityTrigger, setOverrideCanAdd, setOverrideCanModify, setOverrideCanRead

Methods inherited from interface com.evolveum.midpoint.schema.processor.ShadowItemLayeredDefinition

canAdd, canModify, canRead, getLimitations, getMaxOccurs, getMinOccurs, getProcessing, isMandatory, isMultiValue, isOptional, isSingleValue

Methods inherited from interface com.evolveum.midpoint.schema.processor.ShadowItemUcfDefinition

getFrameworkAttributeName, getNativeAttributeName, getReturnedByDefault

Methods inherited from interface com.evolveum.midpoint.util.ShortDumpable

shortDump, shortDump, shortDumpLazily

Methods inherited from interface com.evolveum.midpoint.prism.SmartVisitable

accept

Methods inherited from interface com.evolveum.midpoint.prism.Visitable

accept

Field Details

VALUE

static final ItemName VALUE

Method Details

getImmediateTargetParticipantTypes

@NotNull
@NotNull Collection<AssociationParticipantType> getImmediateTargetParticipantTypes()

Returns "immediate neighbors". TODO

getAssociationObjectInformation

@NotNull
default @NotNull AssociationParticipantType getAssociationObjectInformation()

This is used for associations with the association object.

getImmediateTargetObjectClass

@NotNull
default @NotNull ResourceObjectClassDefinition getImmediateTargetObjectClass()

Returns the object class definition of the immediate target object. Should be exactly one. TEMPORARY IMPLEMENTATION; this should be resolved during definition parsing/creation.

hasAssociationObject

default boolean hasAssociationObject()

getObjectParticipants

@NotNull
default @NotNull com.google.common.collect.Multimap<QName,AssociationParticipantType> getObjectParticipants(@NotNull
 @NotNull CompleteResourceSchema resourceSchema)

TEMPORARY

getObjectDefinitionsFor

default Set<AssociationParticipantType> getObjectDefinitionsFor(@NotNull
 @NotNull ItemName refAttrName,
 @NotNull
 @NotNull CompleteResourceSchema resourceSchema)

matches

default boolean matches(@NotNull
 @NotNull ShadowType potentialTarget)

createTargetObjectsFilter

ObjectFilter createTargetObjectsFilter()

Creates a filter that provides all shadows eligible as the target value for this association. FIXME resolve limitations: - single object class is allowed for given association - if multiple object types are there, then the filter is for the whole class - if type type is the default object type, then it's used as such (even if the whole OC should be returned) TODO are these immediate targets (associated objects, if present), or the "final" targets?

getRepresentativeTargetObjectDefinition

ResourceObjectDefinition getRepresentativeTargetObjectDefinition()

TODO reconsider this: which definition should we provide as the representative one? There can be many.

instantiateFromIdentifierRealValue

@TestOnly
ShadowAssociationValue instantiateFromIdentifierRealValue(@NotNull
 @NotNull QName identifierName,
 @NotNull
 @NotNull Object realValue)
                                                   throws SchemaException

Throws:

SchemaException

createEmptyDelta

ContainerDelta<ShadowAssociationValueType> createEmptyDelta()

getSimulationDefinition

SimulatedShadowReferenceTypeDefinition getSimulationDefinition()

getSimulationDefinitionRequired

SimulatedShadowReferenceTypeDefinition getSimulationDefinitionRequired()

isEntitlement

boolean isEntitlement()

getResourceOid

default String getResourceOid()

clone

@NotNull
@NotNull ShadowReferenceAttributeDefinition clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<PrismContainer<ShadowAssociationValueType>>

Specified by:

clone in interface PrismContainerDefinition<ShadowAssociationValueType>

Specified by:

clone in interface ShadowAttributeDefinition<ShadowReferenceAttribute,ShadowAssociationValueType>

getAssociationDefinitionBean

@Nullable
@Nullable ShadowAssociationDefinitionType getAssociationDefinitionBean()

getAssociationTypeDefinitionBean

@Nullable
@Nullable ShadowAssociationTypeDefinitionType getAssociationTypeDefinitionBean()

hasModernOutbound

default boolean hasModernOutbound()