Package com.evolveum.midpoint.prism.deleg

Interface PrismObjectDelegator<O extends Objectable>

All Superinterfaces:

Cloneable, ComplexCopyable<Item<PrismContainerValue<O>,PrismContainerDefinition<O>>>, DebugDumpable, Freezable, Item<PrismContainerValue<O>,PrismContainerDefinition<O>>, Itemable, ItemDelegator<PrismContainerValue<O>,PrismContainerDefinition<O>>, ParentVisitable, PathVisitable, PrismContainer<O>, PrismContainerable<O>, PrismContainerDelegator<O>, PrismObject<O>, PrismVisitable, Revivable, Serializable, Visitable

public interface PrismObjectDelegator<O extends Objectable>
extends PrismContainerDelegator<O>, PrismObject<O>

Field Summary

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

INDENT_STRING

Fields inherited from interface com.evolveum.midpoint.prism.Item

KEY_NAMESPACE_CONTEXT

Method Summary

Modifier and Type	Method	Description
default <I extends Item<?, ?>> void	addExtensionItem(I item)
default void	addReplaceExisting(Item<?,?> item)
default O	asObjectable()
default PrismObject<O>	clone()	Deprecated.
default @NotNull PrismObject<O>	cloneComplex(@NotNull CloneStrategy strategy)	Complex clone with different cloning strategies.
default PrismObject<O>	cloneIfImmutable()
default ObjectDelta<O>	createAddDelta()
default ObjectDelta<O>	createDeleteDelta()
default ObjectDelta<O>	createDelta(ChangeType changeType)
default PrismContainer<?>	createExtension()
default PrismObject<O>	createImmutableClone()
default ObjectDelta<O>	createModifyDelta()
default PrismObjectValue<O>	createNewValue()
default PrismObjectDefinition<O>	deepCloneDefinition(@NotNull DeepCloneOperation operation)
PrismObject<O>	delegate()
default @NotNull ObjectDelta<O>	diff(PrismObject<O> other)
default @NotNull ObjectDelta<O>	diff(PrismObject<O> other, ParameterizedEquivalenceStrategy strategy)
default boolean	equivalent(Object obj)	This method ignores some part of the object during comparison (e.g. source demarcation in values) These methods compare the "meaningful" parts of the objects.
default <I extends Item<?, ?>> I	findExtensionItem(String elementLocalName)
default <I extends Item<?, ?>> I	findExtensionItem(QName elementName)
default String	getBusinessDisplayName()	Return display name intended for business users of midPoint
default PrismObjectDefinition<O>	getDefinition()	Returns applicable definition.
default PrismContainer<?>	getExtension()
default PrismContainerValue<?>	getExtensionContainerValue()
default PolyString	getName()
default String	getOid()	Returns Object ID (OID).
default PrismContainer<?>	getOrCreateExtension()
default @Nullable PrismContainerValue<?>	getParent()	Returns the parent of this item (if exists).
default @NotNull PrismObjectValue<O>	getValue()	Returns the value, if there is only one.
default String	getVersion()
default boolean	isOfType(@NotNull Class<?> type)
default Collection<? extends ItemDelta<?,?>>	narrowModifications(Collection<? extends ItemDelta<?,?>> modifications, @NotNull ParameterizedEquivalenceStrategy plusStrategy, @NotNull ParameterizedEquivalenceStrategy minusStrategy, boolean assumeMissingItems)	See description of ItemDelta.narrow(PrismObject, Comparator, Comparator, boolean) method.
default <IV extends PrismValue, ID extends ItemDefinition<?>, I extends Item<IV, ID>> void	removeItem(ItemPath path, Class<I> itemType)
default void	setOid(String oid)
default void	setParent(PrismContainerValue<?> parentValue)	Sets the parent of this item.
default void	setValue(@NotNull PrismContainerValue<O> value)
default void	setVersion(String version)
default String	toDebugName()	Returns short string representing identity of this object.
default String	toDebugType()	Returns short string identification of object type.

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

equals, hashCode

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

accept, acceptParentVisitor, acceptVisitor, add, add, addAll, addAll, addIgnoringEquivalents, addRespectingMetadataAndCloning, applyDefinition, applyDefinition, applyDefinitionIfMissing, assertDefinitions, assertDefinitions, assertDefinitions, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistence, checkConsistenceInternal, checkImmutable, checkMutable, clear, contains, contains, debugDump, debugDump, debugDumpLazily, debugDumpLazily, diff, diff, equals, equals, filterValues, filterYields, find, findValue, findValue, freeze, getAllItems, getAllValues, getAnyValue, getAnyValue, getClonedValues, getDisplayName, getElementName, getHelp, getHighestId, getNamespaceContext, getPath, getRealValue, getRealValues, getRealValuesArray, getRealValuesOrRawTypes, getUserData, getUserData, hasAnyValue, hasCompleteDefinition, hashCode, hashCode, hasNoValues, hasRaw, isEmpty, isImmutable, isIncomplete, isOperational, isRaw, isSingleValue, isSingleValueByDefinition, merge, normalize, recomputeAllValues, remove, remove, removeAll, removeIf, removeRespectingMetadata, replace, replaceAll, revive, setDefinition, setElementName, setIncomplete, setUserData, size, valuesStream

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

accept, add, canRepresent, canRepresent, containsItem, createDelta, createDelta, diff, diff, diffModifications, findContainer, findCreateItem, findCreateItem, findItem, findItem, findItem, findOrCreateContainer, findOrCreateItem, findOrCreateItem, findOrCreateProperty, findOrCreateReference, findPartial, findProperty, findReference, findValue, getCompileTimeClass, getComplexTypeDefinition, getPropertyRealValue, getRealValue, getRealValues, getValue, getValues, mergeValue, mergeValues, mergeValues, remove, removeContainer, removeProperty, removeReference, setContainerRealValue, setPropertyRealValue, setPropertyRealValues, setRealValue, trim, trimDefinitionTree

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

copy, doFreeze, immutableCopy, mutableCopy

Method Details

delegate

PrismObject<O> delegate()

Specified by:

delegate in interface ItemDelegator<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

delegate in interface PrismContainerDelegator<O extends Objectable>

createNewValue

default PrismObjectValue<O> createNewValue()

Specified by:

createNewValue in interface PrismContainer<O extends Objectable>

Specified by:

createNewValue in interface PrismContainerDelegator<O extends Objectable>

Specified by:

createNewValue in interface PrismObject<O extends Objectable>

getValue

@NotNull
default @NotNull PrismObjectValue<O> getValue()

Description copied from interface: Item

Returns the value, if there is only one. Throws exception if there are more values. If there is no value, this method either: - returns null (for properties) - throws an exception (for items that can hold multiple values) - creates an empty value (for containers and references). TODO think again whether getOrCreateValue would not be better

Specified by:

getValue in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

getValue in interface ItemDelegator<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

getValue in interface PrismContainer<O extends Objectable>

Specified by:

getValue in interface PrismContainerDelegator<O extends Objectable>

Specified by:

getValue in interface PrismObject<O extends Objectable>

setValue

default void setValue(@NotNull
 @NotNull PrismContainerValue<O> value)
               throws SchemaException

Specified by:

setValue in interface PrismContainer<O extends Objectable>

Specified by:

setValue in interface PrismContainerDelegator<O extends Objectable>

Specified by:

setValue in interface PrismObject<O extends Objectable>

Throws:

SchemaException

getOid

default String getOid()

Description copied from interface: PrismObject

Returns Object ID (OID).

May return null if the object does not have an OID.

Specified by:

getOid in interface PrismObject<O extends Objectable>

Returns:

Object ID (OID)

setOid

default void setOid(String oid)

Specified by:

setOid in interface PrismObject<O extends Objectable>

getVersion

default String getVersion()

Specified by:

getVersion in interface PrismObject<O extends Objectable>

setVersion

default void setVersion(String version)

Specified by:

setVersion in interface PrismObject<O extends Objectable>

getDefinition

default PrismObjectDefinition<O> getDefinition()

Description copied from interface: Item

Returns applicable definition.

May return null if no definition is applicable or the definition is not known.

Specified by:

getDefinition in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

getDefinition in interface Itemable

Specified by:

getDefinition in interface ItemDelegator<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

getDefinition in interface PrismContainer<O extends Objectable>

Specified by:

getDefinition in interface PrismContainerable<O extends Objectable>

Specified by:

getDefinition in interface PrismContainerDelegator<O extends Objectable>

Specified by:

getDefinition in interface PrismObject<O extends Objectable>

Returns:

applicable definition

asObjectable

@NotNull
default O asObjectable()

Specified by:

asObjectable in interface PrismObject<O extends Objectable>

getName

default PolyString getName()

Specified by:

getName in interface PrismObject<O extends Objectable>

getExtension

default PrismContainer<?> getExtension()

Specified by:

getExtension in interface PrismObject<O extends Objectable>

getOrCreateExtension

default PrismContainer<?> getOrCreateExtension()
                                        throws SchemaException

Specified by:

getOrCreateExtension in interface PrismObject<O extends Objectable>

Throws:

SchemaException

getExtensionContainerValue

default PrismContainerValue<?> getExtensionContainerValue()

Specified by:

getExtensionContainerValue in interface PrismObject<O extends Objectable>

findExtensionItem

default <I extends Item<?,
?>> I findExtensionItem(String elementLocalName)

Specified by:

findExtensionItem in interface PrismObject<O extends Objectable>

findExtensionItem

default <I extends Item<?,
?>> I findExtensionItem(QName elementName)

Specified by:

findExtensionItem in interface PrismObject<O extends Objectable>

addExtensionItem

default <I extends Item<?,
?>> void addExtensionItem(I item)
                                             throws SchemaException

Specified by:

addExtensionItem in interface PrismObject<O extends Objectable>

Throws:

SchemaException

createExtension

default PrismContainer<?> createExtension()
                                   throws SchemaException

Specified by:

createExtension in interface PrismObject<O extends Objectable>

Throws:

SchemaException

removeItem

default <IV extends PrismValue,
ID extends ItemDefinition<?>,
I extends Item<IV,
ID>>
void removeItem(ItemPath path,
 Class<I> itemType)

Specified by:

removeItem in interface PrismContainer<O extends Objectable>

Specified by:

removeItem in interface PrismContainerDelegator<O extends Objectable>

Specified by:

removeItem in interface PrismObject<O extends Objectable>

addReplaceExisting

default void addReplaceExisting(Item<?,?> item)
                         throws SchemaException

Specified by:

addReplaceExisting in interface PrismObject<O extends Objectable>

Throws:

SchemaException

clone

@Deprecated
default PrismObject<O> clone()

Deprecated.

Description copied from interface: Item

Literal clone.

Specified by:

clone in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

clone in interface PrismContainer<O extends Objectable>

Specified by:

clone in interface PrismContainerDelegator<O extends Objectable>

Specified by:

clone in interface PrismObject<O extends Objectable>

cloneComplex

@NotNull
default @NotNull PrismObject<O> cloneComplex(@NotNull
 @NotNull CloneStrategy strategy)

Description copied from interface: Item

Complex clone with different cloning strategies.

Specified by:

cloneComplex in interface ComplexCopyable<O extends Objectable>

Specified by:

cloneComplex in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

cloneComplex in interface ItemDelegator<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

cloneComplex in interface PrismContainer<O extends Objectable>

Specified by:

cloneComplex in interface PrismContainerDelegator<O extends Objectable>

Specified by:

cloneComplex in interface PrismObject<O extends Objectable>

See Also:

• CloneStrategy

deepCloneDefinition

default PrismObjectDefinition<O> deepCloneDefinition(@NotNull
 @NotNull DeepCloneOperation operation)

Specified by:

deepCloneDefinition in interface PrismContainer<O extends Objectable>

Specified by:

deepCloneDefinition in interface PrismContainerDelegator<O extends Objectable>

Specified by:

deepCloneDefinition in interface PrismObject<O extends Objectable>

diff

@NotNull
default @NotNull ObjectDelta<O> diff(PrismObject<O> other)

Specified by:

diff in interface PrismObject<O extends Objectable>

diff

@NotNull
default @NotNull ObjectDelta<O> diff(PrismObject<O> other,
 ParameterizedEquivalenceStrategy strategy)

Specified by:

diff in interface PrismObject<O extends Objectable>

narrowModifications

default Collection<? extends ItemDelta<?,?>> narrowModifications(Collection<? extends ItemDelta<?,?>> modifications,
 @NotNull
 @NotNull ParameterizedEquivalenceStrategy plusStrategy,
 @NotNull
 @NotNull ParameterizedEquivalenceStrategy minusStrategy,
 boolean assumeMissingItems)

Description copied from interface: PrismObject

See description of ItemDelta.narrow(PrismObject, Comparator, Comparator, boolean) method.

Specified by:

narrowModifications in interface PrismObject<O extends Objectable>

createDelta

default ObjectDelta<O> createDelta(ChangeType changeType)

Specified by:

createDelta in interface PrismObject<O extends Objectable>

createAddDelta

default ObjectDelta<O> createAddDelta()

Specified by:

createAddDelta in interface PrismObject<O extends Objectable>

createModifyDelta

default ObjectDelta<O> createModifyDelta()

Specified by:

createModifyDelta in interface PrismObject<O extends Objectable>

createDeleteDelta

default ObjectDelta<O> createDeleteDelta()

Specified by:

createDeleteDelta in interface PrismObject<O extends Objectable>

setParent

default void setParent(PrismContainerValue<?> parentValue)

Description copied from interface: Item

Sets the parent of this item.

Specified by:

setParent in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

setParent in interface ItemDelegator<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

setParent in interface PrismObject<O extends Objectable>

Parameters:

parentValue - The new parent

getParent

@Nullable
default @Nullable PrismContainerValue<?> getParent()

Description copied from interface: Item

Returns the parent of this item (if exists). Currently this has to be a PrismContainerValue.

Specified by:

getParent in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

getParent in interface ItemDelegator<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

getParent in interface PrismObject<O extends Objectable>

Returns:

The parent if exists

equivalent

default boolean equivalent(Object obj)

Description copied from interface: PrismContainer

This method ignores some part of the object during comparison (e.g. source demarcation in values) These methods compare the "meaningful" parts of the objects.

Specified by:

equivalent in interface PrismContainer<O extends Objectable>

Specified by:

equivalent in interface PrismContainerDelegator<O extends Objectable>

Specified by:

equivalent in interface PrismObject<O extends Objectable>

toDebugName

default String toDebugName()

Description copied from interface: PrismObject

Returns short string representing identity of this object. It should container object type, OID and name. It should be presented in a form suitable for log and diagnostic messages (understandable for system administrator).

Specified by:

toDebugName in interface PrismObject<O extends Objectable>

toDebugType

default String toDebugType()

Description copied from interface: PrismObject

Returns short string identification of object type. It should be in a form suitable for log messages. There is no requirement for the type name to be unique, but it rather has to be compact. E.g. short element names are preferred to long QNames or URIs.

Specified by:

toDebugType in interface PrismObject<O extends Objectable>

getBusinessDisplayName

default String getBusinessDisplayName()

Description copied from interface: PrismObject

Return display name intended for business users of midPoint

Specified by:

getBusinessDisplayName in interface PrismObject<O extends Objectable>

cloneIfImmutable

default PrismObject<O> cloneIfImmutable()

Specified by:

cloneIfImmutable in interface PrismObject<O extends Objectable>

createImmutableClone

default PrismObject<O> createImmutableClone()

Specified by:

createImmutableClone in interface Item<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

createImmutableClone in interface ItemDelegator<PrismContainerValue<O extends Objectable>,PrismContainerDefinition<O extends Objectable>>

Specified by:

createImmutableClone in interface PrismContainer<O extends Objectable>

Specified by:

createImmutableClone in interface PrismContainerDelegator<O extends Objectable>

Specified by:

createImmutableClone in interface PrismObject<O extends Objectable>

isOfType

default boolean isOfType(@NotNull
 @NotNull Class<?> type)

Specified by:

isOfType in interface PrismObject<O extends Objectable>