Package com.evolveum.midpoint.prism

Interface PrismReferenceDefinition

All Superinterfaces:

Cloneable, DebugDumpable, Definition, Freezable, ItemDefinition<PrismReference>, LivePrismItemDefinition, PrismItemAccessDefinition, PrismItemBasicDefinition, PrismItemStorageDefinition, PrismLifecycleDefinition, PrismPresentationDefinition, Revivable, SchemaLookup.Aware, Serializable, SmartVisitable<Definition>, Visitable<Definition>

All Known Subinterfaces:

PrismReferenceWrapper<R>, ReferenceDefinitionDelegator, ShadowReferenceAttributeDefinition

All Known Implementing Classes:

PrismReferenceWrapperImpl, ShadowReferenceAttributeDefinitionImpl

public interface PrismReferenceDefinition
extends ItemDefinition<PrismReference>

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PrismReferenceDefinition.PrismReferenceDefinitionBuilder
static interface	PrismReferenceDefinition.PrismReferenceDefinitionMutator

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.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.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

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
@NotNull PrismReferenceDefinition	clone()
default @Nullable PrismObjectDefinition<?>	getTargetObjectDefinition()	Returns a definition applicable to the target of this reference.
QName	getTargetTypeName()
@NotNull PrismReference	instantiate()	Create an item instance.
@NotNull PrismReference	instantiate(QName name)	Create an item instance.
boolean	isComposite()
default @NotNull PrismReferenceValue	migrateIfNeeded(@NotNull PrismReferenceValue value)
PrismReferenceDefinition.PrismReferenceDefinitionMutator	mutator()	Returns an interface to mutate this definition.

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, getTypeClass, 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, createEmptyDelta, debugDumpShortToString, deepClone, getProcessing, getSubstitutionHead, getValueEnumerationRef, isAlwaysUseForEquals, isDynamic, isHeterogeneousListItem, isIgnored, isInherited, isOperational, structuredType

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

findItemDefinition, isValidFor

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.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.prism.Revivable

revive

Methods inherited from interface com.evolveum.midpoint.prism.schema.SchemaLookup.Aware

schemaLookup

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

accept

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

accept

Method Details

getTargetTypeName

QName getTargetTypeName()

getTargetObjectDefinition

@Experimental
@Nullable
default @Nullable PrismObjectDefinition<?> getTargetObjectDefinition()

Returns a definition applicable to the target of this reference. Introduced to support shadow association definitions in midPoint: it applies to `ShadowAssociationValueType.shadowRef`.

isComposite

boolean isComposite()

instantiate

@NotNull
@NotNull PrismReference instantiate()

Description copied from interface: ItemDefinition

Create an item instance. Definition name or default name will be used as an element name for the instance. The instance will otherwise be empty.

Specified by:

instantiate in interface ItemDefinition<PrismReference>

instantiate

@NotNull
@NotNull PrismReference instantiate(QName name)

Description copied from interface: ItemDefinition

Create an item instance. Definition name will use provided name. for the instance. The instance will otherwise be empty.

Specified by:

instantiate in interface ItemDefinition<PrismReference>

clone

@NotNull
@NotNull PrismReferenceDefinition clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<PrismReference>

mutator

PrismReferenceDefinition.PrismReferenceDefinitionMutator mutator()

Description copied from interface: Definition

Returns an interface to mutate this definition.

Specified by:

mutator in interface Definition

Specified by:

mutator in interface ItemDefinition<PrismReference>

migrateIfNeeded

@NotNull
default @NotNull PrismReferenceValue migrateIfNeeded(@NotNull
 @NotNull PrismReferenceValue value)
                                              throws SchemaException

Throws:

SchemaException