Package com.evolveum.midpoint.prism.deleg

Interface PrismReferenceValueDelegator

All Superinterfaces:

ComplexCopyable<PrismValue>, DebugDumpable, Freezable, MidpointOriginMetadata, PathVisitable, PrismReferenceValue, PrismValue, PrismValueDelegator, PrismVisitable, Revivable, SchemaLookup.Aware, Serializable, ShortDumpable, Visitable

public interface PrismReferenceValueDelegator
extends PrismReferenceValue, PrismValueDelegator

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
default boolean	acceptVisitor(PrismVisitor visitor)	Accept visitor and visits prism item or value and it's children Note: name is not accept, but accept visitor to prevent naming conflict in lambdas dynamic languages such as groovy with Visitable.accept(com.evolveum.midpoint.prism.Visitor)
default PrismReferenceValue	applyDefinition(PrismReferenceDefinition definition, boolean force)
default Referencable	asReferencable()
default PrismReferenceValue	clone()	Literal clone.
default PrismReferenceValue	cloneComplex(@NotNull CloneStrategy strategy)	Complex clone with different cloning strategies.
default PrismReferenceValue	createImmutableClone()
default String	debugDump(int indent, boolean expandObject)
PrismReferenceValue	delegate()
default @Nullable QName	determineTargetTypeName()	Determines the type name from the value or from its definition (if known).
default <IV extends PrismValue, ID extends ItemDefinition<?>> PartiallyResolvedItem<IV,ID>	findPartial(ItemPath path)
default <I extends Item<?, ?>> I	findReferencedItem(ItemPath path, Class<I> type)
default PrismReferenceDefinition	getDefinition()
default String	getDescription()
default @NotNull EvaluationTimeType	getEffectiveResolutionTime()
default SearchFilterType	getFilter()
default <O extends Objectable> PrismObject<O>	getObject()	Returns object that this reference points to.
default Objectable	getObjectable()
default String	getOid()	OID of the object that this reference refers to (reference target).
default Class<?>	getRealClass()
default @Nullable Referencable	getRealValue()	Returns the statically-typed "real value".
default ReferentialIntegrityType	getReferentialIntegrity()
default QName	getRelation()
default EvaluationTimeType	getResolutionTime()
default PolyString	getTargetName()	Returns cached name of the target object.
default QName	getTargetType()	Returns XSD type of the object that this reference refers to.
default Class<Objectable>	getTargetTypeCompileTimeClass()
default PrismReferenceValue	relation(QName relation)
default void	setDescription(String description)
default void	setFilter(SearchFilterType filter)
default void	setObject(PrismObject<?> object)
default void	setOid(String oid)
default void	setReferentialIntegrity(ReferentialIntegrityType referentialIntegrity)
default void	setRelation(QName relation)
default void	setResolutionTime(EvaluationTimeType resolutionTime)
default void	setTargetName(PolyString name)
default void	setTargetName(PolyStringType name)
default void	setTargetType(QName targetType)
default void	setTargetType(QName targetType, boolean allowEmptyNamespace)
default PrismReferenceValue	toCanonical()	Returns a version of this value that is canonical, that means it has the minimal form.

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

checkImmutable, checkMutable, freeze, isImmutable

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

copy, immutableCopy, mutableCopy

Methods inherited from interface com.evolveum.midpoint.prism.deleg.PrismValueDelegator

accept, accept, applyDefinition, applyDefinition, applyDefinitionLegacy, applyDefinitionLegacy, checkConsistenceInternal, clearParent, cloneIfImmutable, debugDump, debugDump, debugDumpLazily, debugDumpLazily, deleteValueMetadata, diff, equals, equals, find, getAllItems, getAllValues, getNearestValueOfType, getOriginObject, getOriginType, getParent, getParentContainerValue, getPath, getRealValueIfExists, getRealValueOrRawType, getRootObjectable, getRootValue, getSchemaContext, getTypeName, getUserData, getUserData, getValueMetadata, getValueMetadataAsContainer, getValueMetadataIfExists, hashCode, hashCode, hasRealClass, hasValueMetadata, isEmpty, isObjectable, isOfType, isRaw, isTransient, normalize, recompute, recompute, representsSameValue, schemaLookup, setOriginObject, setOriginType, setParent, setTransient, setUserData, setValueMetadata, setValueMetadata, setValueMetadata, toHumanReadableString

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

revive

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

shortDump, shortDump, shortDumpLazily

Method Details

delegate

PrismReferenceValue delegate()

Specified by:

delegate in interface PrismValueDelegator

getOid

default String getOid()

Description copied from interface: PrismReferenceValue

OID of the object that this reference refers to (reference target). May return null, but the reference is in that case incomplete and unusable.

Specified by:

getOid in interface PrismReferenceValue

Returns:

the target oid

setOid

default void setOid(String oid)

Specified by:

setOid in interface PrismReferenceValue

getObject

default <O extends Objectable> PrismObject<O> getObject()

Description copied from interface: PrismReferenceValue

Returns object that this reference points to. The object is supposed to be used for caching and optimizations. Only oid and type of the object really matters for the reference. The object is transient. It will NOT be serialized. Therefore the client must expect that the object can disappear when serialization boundary is crossed. The client must expect that the object is null.

Specified by:

getObject in interface PrismReferenceValue

getObjectable

default Objectable getObjectable()

Specified by:

getObjectable in interface PrismReferenceValue

setObject

default void setObject(PrismObject<?> object)

Specified by:

setObject in interface PrismReferenceValue

getTargetType

default QName getTargetType()

Description copied from interface: PrismReferenceValue

Returns XSD type of the object that this reference refers to. It may be used in XPath expressions and similar filters. May return null if the type name is not set.

Specified by:

getTargetType in interface PrismReferenceValue

Returns:

the target type name

setTargetType

default void setTargetType(QName targetType)

Specified by:

setTargetType in interface PrismReferenceValue

setTargetType

default void setTargetType(QName targetType,
 boolean allowEmptyNamespace)

Specified by:

setTargetType in interface PrismReferenceValue

allowEmptyNamespace - This is an ugly hack. See comment in DOMUtil.validateNonEmptyQName.

determineTargetTypeName

@Nullable
default @Nullable QName determineTargetTypeName()

Description copied from interface: PrismReferenceValue

Determines the type name from the value or from its definition (if known).

Specified by:

determineTargetTypeName in interface PrismReferenceValue

getTargetName

default PolyString getTargetName()

Description copied from interface: PrismReferenceValue

Returns cached name of the target object. This is a ephemeral value. It may be computed at object retrieval time or it may not be present at all. This is NOT an authoritative information. Setting it or changing it will not influence the reference meaning. OID is the only authoritative linking mechanism.

Specified by:

getTargetName in interface PrismReferenceValue

Returns:

cached name of the target object.

setTargetName

default void setTargetName(PolyString name)

Specified by:

setTargetName in interface PrismReferenceValue

setTargetName

default void setTargetName(PolyStringType name)

Specified by:

setTargetName in interface PrismReferenceValue

getTargetTypeCompileTimeClass

default Class<Objectable> getTargetTypeCompileTimeClass()

Specified by:

getTargetTypeCompileTimeClass in interface PrismReferenceValue

getRelation

default QName getRelation()

Specified by:

getRelation in interface PrismReferenceValue

setRelation

default void setRelation(QName relation)

Specified by:

setRelation in interface PrismReferenceValue

relation

default PrismReferenceValue relation(QName relation)

Specified by:

relation in interface PrismReferenceValue

getDescription

default String getDescription()

Specified by:

getDescription in interface PrismReferenceValue

setDescription

default void setDescription(String description)

Specified by:

setDescription in interface PrismReferenceValue

getFilter

default SearchFilterType getFilter()

Specified by:

getFilter in interface PrismReferenceValue

setFilter

default void setFilter(SearchFilterType filter)

Specified by:

setFilter in interface PrismReferenceValue

getResolutionTime

default EvaluationTimeType getResolutionTime()

Specified by:

getResolutionTime in interface PrismReferenceValue

getEffectiveResolutionTime

@NotNull
default @NotNull EvaluationTimeType getEffectiveResolutionTime()

Specified by:

getEffectiveResolutionTime in interface PrismReferenceValue

setResolutionTime

default void setResolutionTime(EvaluationTimeType resolutionTime)

Specified by:

setResolutionTime in interface PrismReferenceValue

getReferentialIntegrity

default ReferentialIntegrityType getReferentialIntegrity()

Specified by:

getReferentialIntegrity in interface PrismReferenceValue

setReferentialIntegrity

default void setReferentialIntegrity(ReferentialIntegrityType referentialIntegrity)

Specified by:

setReferentialIntegrity in interface PrismReferenceValue

getDefinition

default PrismReferenceDefinition getDefinition()

Specified by:

getDefinition in interface PrismReferenceValue

findPartial

default <IV extends PrismValue,
ID extends ItemDefinition<?>>
PartiallyResolvedItem<IV,ID> findPartial(ItemPath path)

Specified by:

findPartial in interface PrismReferenceValue

applyDefinition

default PrismReferenceValue applyDefinition(PrismReferenceDefinition definition,
 boolean force)
                                     throws SchemaException

Specified by:

applyDefinition in interface PrismReferenceValue

Throws:

SchemaException

toCanonical

default PrismReferenceValue toCanonical()

Description copied from interface: PrismReferenceValue

Returns a version of this value that is canonical, that means it has the minimal form. E.g. it will have only OID and no object.

Specified by:

toCanonical in interface PrismReferenceValue

asReferencable

default Referencable asReferencable()

Specified by:

asReferencable in interface PrismReferenceValue

debugDump

default String debugDump(int indent,
 boolean expandObject)

Specified by:

debugDump in interface PrismReferenceValue

clone

default PrismReferenceValue clone()

Description copied from interface: PrismValue

Literal clone.

Specified by:

clone in interface PrismReferenceValue

Specified by:

clone in interface PrismValue

Specified by:

clone in interface PrismValueDelegator

createImmutableClone

default PrismReferenceValue createImmutableClone()

Specified by:

createImmutableClone in interface PrismReferenceValue

Specified by:

createImmutableClone in interface PrismValue

Specified by:

createImmutableClone in interface PrismValueDelegator

cloneComplex

default PrismReferenceValue cloneComplex(@NotNull
 @NotNull CloneStrategy strategy)

Description copied from interface: PrismValue

Complex clone with different cloning strategies.

Specified by:

cloneComplex in interface ComplexCopyable<PrismValue>

Specified by:

cloneComplex in interface PrismReferenceValue

Specified by:

cloneComplex in interface PrismValue

Specified by:

cloneComplex in interface PrismValueDelegator

See Also:

• CloneStrategy

getRealClass

default Class<?> getRealClass()

Specified by:

getRealClass in interface PrismReferenceValue

Specified by:

getRealClass in interface PrismValue

Specified by:

getRealClass in interface PrismValueDelegator

getRealValue

@Nullable
default @Nullable Referencable getRealValue()

Description copied from interface: PrismValue

Returns the statically-typed "real value". TODO specify when exactly the returned value can be null. TODO decide for containers: they throw an exception if the value is not statically typed.

Specified by:

getRealValue in interface PrismReferenceValue

Specified by:

getRealValue in interface PrismValue

Specified by:

getRealValue in interface PrismValueDelegator

findReferencedItem

@Experimental
default <I extends Item<?,
?>> I findReferencedItem(ItemPath path,
 Class<I> type)

Specified by:

findReferencedItem in interface PrismReferenceValue

acceptVisitor

default boolean acceptVisitor(PrismVisitor visitor)

Description copied from interface: PrismVisitable

Accept visitor and visits prism item or value and it's children Note: name is not accept, but accept visitor to prevent naming conflict in lambdas dynamic languages such as groovy with Visitable.accept(com.evolveum.midpoint.prism.Visitor)

Specified by:

acceptVisitor in interface PrismReferenceValue

Specified by:

acceptVisitor in interface PrismValue

Specified by:

acceptVisitor in interface PrismValueDelegator

Specified by:

acceptVisitor in interface PrismVisitable

Returns:

return value of PrismVisitor.visit(PrismVisitable) invocation for this visitable.