Package com.evolveum.midpoint.gui.impl.prism.wrapper

Class ItemWrapperImpl<I extends Item<?,?>,VW extends PrismValueWrapper>

java.lang.Object

com.evolveum.midpoint.gui.impl.prism.wrapper.ItemWrapperImpl<I,VW>

All Implemented Interfaces:

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

Direct Known Subclasses:

PrismContainerWrapperImpl, PrismPropertyWrapperImpl, PrismReferenceWrapperImpl

public abstract class ItemWrapperImpl<I extends Item<?,?>,VW extends PrismValueWrapper>
extends Object
implements ItemWrapper<I,VW>, Serializable

Author:

katka

See Also:

• Serialized Form

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

Constructor Summary

Constructors

Constructor	Description
ItemWrapperImpl(PrismContainerValueWrapper<?> parent, I item, ItemStatus status)

Method Summary

Modifier and Type	Method	Description
<PV extends PrismValue> void	add(PV newValue, ModelServiceLocator locator)
protected <D extends ItemDelta<? extends PrismValue, ? extends ItemDefinition>> void	addValueToDelta(VW value, D delta)
boolean	canAdd()	Returns true if this item can be added: it can be part of an object that is created.
boolean	canModify()	Returns true if this item can be modified (updated).
boolean	canRead()	Returns true if this item can be read (displayed).
boolean	checkRequired()
@NotNull ItemDefinition<I>	clone()
protected <D extends ItemDelta<? extends PrismValue, ? extends ItemDefinition>> Collection<D>	computeDeltaInternal()
@NotNull ItemDelta	createEmptyDelta(ItemPath path)	Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.
protected abstract <PV extends PrismValue> PV	createNewEmptyValue(ModelServiceLocator locator)
String	debugDump(int indent)
void	debugDumpShortToString(StringBuilder sb)	Used in debugDumping items.
ItemDefinition<I>	deepClone(@NotNull DeepCloneOperation operation)	TODO document
<T extends ItemDefinition<?>> T	findItemDefinition(@NotNull ItemPath path, @NotNull Class<T> clazz)	Used to find a matching item definition _within_ this definition.
ItemStatus	findObjectStatus()
<OW extends PrismObjectWrapper<O>, O extends ObjectType> OW	findObjectWrapper()
<A> A	getAnnotation(QName qname)	Returns generic definition annotation.
@Nullable Map<QName,Object>	getAnnotations()	Returns all annotations, as unmodifiable map.
<D extends ItemDelta<? extends PrismValue, ? extends ItemDefinition>> Collection<D>	getDelta()
String	getDeprecatedSince()
List<ItemDiagramSpecification>	getDiagrams()
DisplayHint	getDisplayHint()	Enumeration annotation that specifies how/whether the item should be displayed.
String	getDisplayName()	Returns display name.
Integer	getDisplayOrder()	Specifies an order in which the item should be displayed relative to other items at the same level.
String	getDocumentation()	Must contains tag because of html tags used in text.
String	getDocumentationPreview()	Returns only a first sentence of documentation.
ExpressionType	getFormComponentValidator()
String	getHelp()	Returns help string.
I	getItem()
@NotNull ItemName	getItemName()	Gets the "canonical" name of the item for the definition.
int	getMaxOccurs()	Returns the number of maximal value occurrences.
@Nullable String	getMergerIdentifier()
@Nullable ItemMerger	getMergerInstance(@NotNull MergeStrategy strategy, @Nullable OriginMarker originMarker)
int	getMinOccurs()	Returns the number of minimal value occurrences.
@Nullable List<QName>	getNaturalKeyConstituents()
@Nullable NaturalKeyDefinition	getNaturalKeyInstance()
I	getOldItem()
PrismContainerValueWrapper<?>	getParent()
<C extends Containerable> PrismContainerValueWrapper<C>	getParentContainerValue(Class<? extends C> parentClass)
ItemPath	getPath()
String	getPlannedRemoval()	Version of data model in which the item is likely to be removed.
Collection<ExecutedDeltaPostProcessor>	getPreconditionDeltas(ModelServiceLocator serviceLocator, OperationResult result)	Collect processor with deltas and consumer, that should be processed before basic deltas of showed object
ItemProcessing	getProcessing()
String	getRemovedSince()
List<SchemaMigration>	getSchemaMigrations()
ItemStatus	getStatus()
QName	getSubstitutionHead()	Returns the name of an element this one can be substituted for (e.g.
Class<?>	getTypeClass()	Returns a compile-time class that is used to represent items.
@NotNull QName	getTypeName()	Returns a name of the type for this definition.
VW	getValue()
PrismReferenceValue	getValueEnumerationRef()	Reference to an object that directly or indirectly represents possible values for this item.
List<VW>	getValues()
UserInterfaceElementVisibilityType	getVisibleOverwrite()
I	instantiate()	Create an item instance.
I	instantiate(QName name)	Create an item instance.
boolean	isAbstract()	For types: is the type abstract so that it should not be instantiated directly? For items: TODO
boolean	isAlwaysUseForEquals()	Item which should always be used for equals even if it is operational and strategy does not consider operational items.
boolean	isColumn()
boolean	isDeprecated()
boolean	isDynamic()	Returns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML.
boolean	isElaborate()	Elaborate items are complicated data structure that may deviate from normal principles of the system.
boolean	isEmphasized()	True for definitions that are more important than others and that should be emphasized during presentation.
boolean	isEmpty()
boolean	isExperimental()	Experimental functionality is not stable and it may be changed in any future release without any warning.
boolean	isHeterogeneousListItem()	Can be used in heterogeneous lists as a list item.
boolean	isIgnored()	Deprecated.
boolean	isIndexOnly()	If true, this item is not stored in XML representation in repo.
boolean	isInherited()	Whether the item is inherited from a supertype.
boolean	isMetadata()
boolean	isOperational()	Marks operational item.
boolean	isOptionalCleanup()	Marks item that could be ignored by SCM tools (e.g.
boolean	isProcessProvenanceMetadata()
boolean	isReadOnly()
boolean	isRemoved()
boolean	isRuntimeSchema()	This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.
boolean	isShowEmpty()
boolean	isShowInVirtualContainer()
boolean	isShowMetadataDetails()
boolean	isValidated()
boolean	isValidFor(@NotNull QName elementQName, @NotNull Class<? extends ItemDefinition<?>> clazz, boolean caseInsensitive)	Returns true if this definition is valid for given element name and definition class, in either case-sensitive (the default) or case-insensitive way.
boolean	isVisible(PrismContainerValueWrapper<?> parent, ItemVisibilityHandler visibilityHandler)
protected boolean	isVisibleByVisibilityHandler(ItemVisibilityHandler visibilityHandler)
ItemDefinition.ItemDefinitionMutator	mutator()	Returns an interface to mutate this definition.
void	remove(VW valueWrapper, ModelServiceLocator locator)
void	removeAll(ModelServiceLocator locator)
void	revive(PrismContext prismContext)	TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)
void	setColumn(boolean column)
void	setDisplayName(String displayName)
void	setDisplayOrder(Integer displayOrder)
void	setMetadata(boolean metadata)
void	setProcessProvenanceMetadata(boolean processProvenanceMetadata)
void	setReadOnly(boolean readOnly)
void	setShowEmpty(boolean isShowEmpty, boolean recursive)
void	setShowInVirtualContainer(boolean showInVirtualContainer)
void	setShowMetadataDetails(boolean showMetadataDetails)
void	setValidated(boolean validated)
void	setVisibleOverwrite(UserInterfaceElementVisibilityType visibleOverwrite)
Optional<ComplexTypeDefinition>	structuredType()	Returns complex type definition of item, if underlying value is possible structured.
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

debugDump, debugDumpLazily, debugDumpLazily

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

checkMutableOnExposing, debugDump, getMutabilityFlag, getSchemaContextDefinition

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

checkImmutable, checkMutable, freeze, isImmutable

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

cloneWithNewName

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

getInfo

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

isMandatory, isMultiValue, isOptional, isSingleValue

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

isIndexed, isSearchable

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

Constructor Details

ItemWrapperImpl

public ItemWrapperImpl(PrismContainerValueWrapper<?> parent,
 I item,
 ItemStatus status)

Method Details

getDelta

public <D extends ItemDelta<? extends PrismValue,
? extends ItemDefinition>>
Collection<D> getDelta()
                throws SchemaException

Specified by:

getDelta in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

Throws:

SchemaException

computeDeltaInternal

protected <D extends ItemDelta<? extends PrismValue,
? extends ItemDefinition>>
Collection<D> computeDeltaInternal()
                            throws SchemaException

Throws:

SchemaException

addValueToDelta

protected <D extends ItemDelta<? extends PrismValue,
? extends ItemDefinition>>
void addValueToDelta(VW value,
 D delta)
              throws SchemaException

Throws:

SchemaException

getDisplayName

public String getDisplayName()

Description copied from interface: PrismPresentationDefinition

Returns display name. Specifies the printable name of the object class or attribute. It must contain a printable string. It may also contain a key to catalog file. Returns null if no display name is set. Corresponds to "displayName" XSD annotation.

Specified by:

getDisplayName in interface PrismPresentationDefinition

Returns:

display name string or catalog key

setDisplayName

public void setDisplayName(String displayName)

getHelp

public String getHelp()

Description copied from interface: PrismPresentationDefinition

Returns help string. Specifies the help text or a key to catalog file for a help text. The help text may be displayed in any suitable way by the GUI. It should explain the meaning of an attribute or object class. Returns null if no help string is set. Corresponds to "help" XSD annotation.

Specified by:

getHelp in interface PrismPresentationDefinition

Returns:

help string or catalog key

isExperimental

public boolean isExperimental()

Description copied from interface: PrismLifecycleDefinition

Experimental functionality is not stable and it may be changed in any future release without any warning. Use at your own risk.

Specified by:

isExperimental in interface PrismLifecycleDefinition

getDeprecatedSince

public String getDeprecatedSince()

Specified by:

getDeprecatedSince in interface PrismLifecycleDefinition

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface PrismLifecycleDefinition

isOptionalCleanup

public boolean isOptionalCleanup()

Description copied from interface: Definition

Marks item that could be ignored by SCM tools (e.g. Git), or removed before commit.

Specified by:

isOptionalCleanup in interface Definition

isRemoved

public boolean isRemoved()

Specified by:

isRemoved in interface PrismLifecycleDefinition

getRemovedSince

public String getRemovedSince()

Specified by:

getRemovedSince in interface PrismLifecycleDefinition

getStatus

public ItemStatus getStatus()

Specified by:

getStatus in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

getItem

public I getItem()

Specified by:

getItem in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

setColumn

public void setColumn(boolean column)

Specified by:

setColumn in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

isColumn

public boolean isColumn()

Specified by:

isColumn in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

getParent

public PrismContainerValueWrapper<?> getParent()

Specified by:

getParent in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

getPath

public ItemPath getPath()

Specified by:

getPath in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

getFormComponentValidator

public ExpressionType getFormComponentValidator()

Specified by:

getFormComponentValidator in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable

Specified by:

debugDump in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

findObjectStatus

public ItemStatus findObjectStatus()

Specified by:

findObjectStatus in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

findObjectWrapper

public <OW extends PrismObjectWrapper<O>,
O extends ObjectType>
OW findObjectWrapper()

Specified by:

findObjectWrapper in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

getValues

public List<VW> getValues()

Specified by:

getValues in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

getValue

public VW getValue()
            throws SchemaException

Specified by:

getValue in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

Throws:

SchemaException

checkRequired

public boolean checkRequired()

Specified by:

checkRequired in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

isShowEmpty

public boolean isShowEmpty()

Specified by:

isShowEmpty in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

setShowEmpty

public void setShowEmpty(boolean isShowEmpty,
 boolean recursive)

Specified by:

setShowEmpty in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

isShowInVirtualContainer

public boolean isShowInVirtualContainer()

Specified by:

isShowInVirtualContainer in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

setShowInVirtualContainer

public void setShowInVirtualContainer(boolean showInVirtualContainer)

Specified by:

setShowInVirtualContainer in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

setVisibleOverwrite

public void setVisibleOverwrite(UserInterfaceElementVisibilityType visibleOverwrite)

Specified by:

setVisibleOverwrite in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

getItemName

@NotNull
public @NotNull ItemName getItemName()

Description copied from interface: PrismItemBasicDefinition

Gets the "canonical" name of the item for the definition. Should be qualified, if at all possible.

Specified by:

getItemName in interface PrismItemBasicDefinition

getMinOccurs

public int getMinOccurs()

Description copied from interface: PrismItemBasicDefinition

Returns the number of minimal value occurrences.

Specified by:

getMinOccurs in interface PrismItemBasicDefinition

getMaxOccurs

public int getMaxOccurs()

Description copied from interface: PrismItemBasicDefinition

Returns the number of maximal value occurrences. Any negative number means "unbounded".

Specified by:

getMaxOccurs in interface PrismItemBasicDefinition

isOperational

public boolean isOperational()

Description copied from interface: ItemDefinition

Marks operational item. Operational properties are auxiliary data (or meta-data) that are usually not modifiable by the end user. They are generated and maintained by the system. Operational items are also not usually displayed unless it is explicitly requested. The example of operational items are modification timestamps, create timestamps, user that made the last change, etc. They are also treated in a special way when comparing values. See ParameterizedEquivalenceStrategy.

Specified by:

isOperational in interface ItemDefinition<I extends Item<?,?>>

isInherited

public boolean isInherited()

Description copied from interface: ItemDefinition

Whether the item is inherited from a supertype.

Specified by:

isInherited in interface ItemDefinition<I extends Item<?,?>>

isDynamic

public boolean isDynamic()

Description copied from interface: ItemDefinition

Returns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML. This means that the definition needs to be stored alongside the data to have a successful serialization "roundtrip". The definition is not part of any schema and therefore cannot be determined. It may even be different for every instance of the associated item (element name).

Specified by:

isDynamic in interface ItemDefinition<I extends Item<?,?>>

canRead

public boolean canRead()

Description copied from interface: PrismItemAccessDefinition

Returns true if this item can be read (displayed). In case of containers this flag is, strictly speaking, not applicable. Container is an empty shell. What matters is access to individual sub-item. However, for containers this value has a "hint" meaning. It means that the container itself contains something that is readable. Which can be used as a hint by the presentation to display container label or block. This usually happens if the container contains at least one readable item. This does NOT mean that also all the container items can be displayed. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.

Note: It was considered to use a different meaning for this flag - a meaning that would allow canRead()=false containers to have readable items. However, this was found not to be very useful. Therefore the "something readable inside" meaning was confirmed instead.

Specified by:

canRead in interface PrismItemAccessDefinition

canModify

public boolean canModify()

Description copied from interface: PrismItemAccessDefinition

Returns true if this item can be modified (updated). In case of containers this means that the container itself should be displayed in modification forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one modifiable item. This does NOT mean that also all the container items can be modified. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.

Specified by:

canModify in interface PrismItemAccessDefinition

canAdd

public boolean canAdd()

Description copied from interface: PrismItemAccessDefinition

Returns true if this item can be added: it can be part of an object that is created. In case of containers this means that the container itself should be displayed in creation forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one createable item. This does NOT mean that also all the container items can be created. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.

Specified by:

canAdd in interface PrismItemAccessDefinition

getSubstitutionHead

public QName getSubstitutionHead()

Description copied from interface: ItemDefinition

Returns the name of an element this one can be substituted for (e.g. c:user -> c:object, s:pipeline -> s:expression, etc). EXPERIMENTAL

Specified by:

getSubstitutionHead in interface ItemDefinition<I extends Item<?,?>>

isHeterogeneousListItem

public boolean isHeterogeneousListItem()

Description copied from interface: ItemDefinition

Can be used in heterogeneous lists as a list item. EXPERIMENTAL.

Specified by:

isHeterogeneousListItem in interface ItemDefinition<I extends Item<?,?>>

getValueEnumerationRef

public PrismReferenceValue getValueEnumerationRef()

Description copied from interface: ItemDefinition

Reference to an object that directly or indirectly represents possible values for this item. We do not define here what exactly the object has to be. It can be a lookup table, script that dynamically produces the values or anything similar. The object must produce the values of the correct type for this item otherwise an error occurs.

Specified by:

getValueEnumerationRef in interface ItemDefinition<I extends Item<?,?>>

isValidFor

public boolean isValidFor(@NotNull
 @NotNull QName elementQName,
 @NotNull
 @NotNull Class<? extends ItemDefinition<?>> clazz,
 boolean caseInsensitive)

Description copied from interface: LivePrismItemDefinition

Returns true if this definition is valid for given element name and definition class, in either case-sensitive (the default) or case-insensitive way. Used e.g. for "slow" path lookup where we iterate over all definitions in a complex type.

Specified by:

isValidFor in interface LivePrismItemDefinition

instantiate

@NotNull
public I instantiate()
              throws SchemaException

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<I extends Item<?,?>>

Throws:

SchemaException

instantiate

@NotNull
public I instantiate(QName name)
              throws SchemaException

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<I extends Item<?,?>>

Throws:

SchemaException

findItemDefinition

public <T extends ItemDefinition<?>> T findItemDefinition(@NotNull
 @NotNull ItemPath path,
 @NotNull
 @NotNull Class<T> clazz)

Description copied from interface: LivePrismItemDefinition

Used to find a matching item definition _within_ this definition. Treats e.g. de-referencing in prism references.

Specified by:

findItemDefinition in interface LivePrismItemDefinition

createEmptyDelta

@NotNull
public @NotNull ItemDelta createEmptyDelta(ItemPath path)

Description copied from interface: ItemDefinition

Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.

Specified by:

createEmptyDelta in interface ItemDefinition<I extends Item<?,?>>

clone

@NotNull
public @NotNull ItemDefinition<I> clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<I extends Item<?,?>>

Overrides:

clone in class Object

deepClone

public ItemDefinition<I> deepClone(@NotNull
 @NotNull DeepCloneOperation operation)

Description copied from interface: ItemDefinition

TODO document

Specified by:

deepClone in interface ItemDefinition<I extends Item<?,?>>

revive

public void revive(PrismContext prismContext)

Description copied from interface: Revivable

TODO: Is revive necessary if prism context is static? TODO document (if it's found to be necessary)

Specified by:

revive in interface Revivable

debugDumpShortToString

public void debugDumpShortToString(StringBuilder sb)

Description copied from interface: ItemDefinition

Used in debugDumping items. Does not need to have name in it as item already has it. Does not need to have class as that is just too much info that is almost anytime pretty obvious anyway.

Specified by:

debugDumpShortToString in interface ItemDefinition<I extends Item<?,?>>

mutator

public ItemDefinition.ItemDefinitionMutator 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<I extends Item<?,?>>

getTypeName

@NotNull
public @NotNull QName getTypeName()

Description copied from interface: Definition

Returns a name of the type for this definition. The type can be part of the compile-time schema or it can be defined at run time. Examples of the former case are types like c:UserType, xsd:string, or even flexible ones like c:ExtensionType or c:ShadowAttributesType. Examples of the latter case are types used in - custom extensions, like ext:LocationsType (where ext = e.g. http://example.com/extension), - resource schema, like ri:inetOrgPerson (ri = http://.../resource/instance-3), - connector schema, like TODO In XML representation that corresponds to the name of the XSD type. Although beware, the run-time types do not have statically defined structure. And the resource and connector-related types may even represent different kinds of objects within different contexts (e.g. two distinct resources both with ri:AccountObjectClass types). Also note that for complex type definitions, the type name serves as a unique identifier. On the other hand, for item definitions, it is just one of its attributes; primary key is item name in that case. The type name should be fully qualified. (TODO reconsider this)

Specified by:

getTypeName in interface Definition

Specified by:

getTypeName in interface PrismItemBasicDefinition

Returns:

the type name

isRuntimeSchema

public boolean isRuntimeSchema()

Description copied from interface: Definition

This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g. extension schema, resource schema or connector schema or something like that. I.e. it is not defined statically.

Specified by:

isRuntimeSchema in interface Definition

isIgnored

@Deprecated
public boolean isIgnored()

Deprecated.

Specified by:

isIgnored in interface ItemDefinition<I extends Item<?,?>>

getProcessing

public ItemProcessing getProcessing()

Specified by:

getProcessing in interface ItemDefinition<I extends Item<?,?>>

isAbstract

public boolean isAbstract()

Description copied from interface: Definition

For types: is the type abstract so that it should not be instantiated directly? For items: TODO

Specified by:

isAbstract in interface Definition

getPlannedRemoval

public String getPlannedRemoval()

Description copied from interface: PrismLifecycleDefinition

Version of data model in which the item is likely to be removed. This annotation is used for deprecated item to indicate imminent incompatibility in future versions of data model.

Specified by:

getPlannedRemoval in interface PrismLifecycleDefinition

isElaborate

public boolean isElaborate()

Description copied from interface: Definition

Elaborate items are complicated data structure that may deviate from normal principles of the system. For example elaborate items may not be supported in user interface and may only be manageable by raw edits or a special-purpose tools. Elaborate items may be not fully supported by authorizations, schema tools and so on.

Specified by:

isElaborate in interface Definition

getDisplayHint

public DisplayHint getDisplayHint()

Description copied from interface: PrismPresentationDefinition

Enumeration annotation that specifies how/whether the item should be displayed. It is also a replacement for the old "emphasized" annotation.

Specified by:

getDisplayHint in interface PrismPresentationDefinition

getNaturalKeyConstituents

@Nullable
public @Nullable List<QName> getNaturalKeyConstituents()

Specified by:

getNaturalKeyConstituents in interface Definition

getMergerIdentifier

@Nullable
public @Nullable String getMergerIdentifier()

Specified by:

getMergerIdentifier in interface Definition

getNaturalKeyInstance

@Nullable
public @Nullable NaturalKeyDefinition getNaturalKeyInstance()

Specified by:

getNaturalKeyInstance in interface Definition

getMergerInstance

@Nullable
public @Nullable ItemMerger getMergerInstance(@NotNull
 @NotNull MergeStrategy strategy,
 @Nullable
 @Nullable OriginMarker originMarker)

Specified by:

getMergerInstance in interface Definition

isAlwaysUseForEquals

public boolean isAlwaysUseForEquals()

Description copied from interface: ItemDefinition

Item which should always be used for equals even if it is operational and strategy does not consider operational items. EXPERIMENTAL

Specified by:

isAlwaysUseForEquals in interface ItemDefinition<I extends Item<?,?>>

isEmphasized

public boolean isEmphasized()

Description copied from interface: PrismPresentationDefinition

True for definitions that are more important than others and that should be emphasized during presentation. E.g. the emphasized definitions will always be displayed in the user interfaces (even if they are empty), they will always be included in the dumps, etc. TODO probably deprecated, isn't it?

Specified by:

isEmphasized in interface PrismPresentationDefinition

getDisplayOrder

public Integer getDisplayOrder()

Description copied from interface: PrismPresentationDefinition

Specifies an order in which the item should be displayed relative to other items at the same level. The items will be displayed by sorting them by the values of displayOrder annotation (ascending). Items that do not have any displayOrder annotation will be displayed last. The ordering of values with the same displayOrder is undefined and it may be arbitrary.

Specified by:

getDisplayOrder in interface PrismPresentationDefinition

setDisplayOrder

public void setDisplayOrder(Integer displayOrder)

getDocumentation

public String getDocumentation()

Description copied from interface: PrismPresentationDefinition

Must contains tag because of html tags used in text.

Specified by:

getDocumentation in interface PrismPresentationDefinition

getDocumentationPreview

public String getDocumentationPreview()

Description copied from interface: PrismPresentationDefinition

Returns only a first sentence of documentation.

Specified by:

getDocumentationPreview in interface PrismPresentationDefinition

getTypeClass

public Class<?> getTypeClass()

Description copied from interface: Definition

Returns a compile-time class that is used to represent items. E.g. returns String, Integer, subclasses of Objectable and Containerable and so on.

Specified by:

getTypeClass in interface Definition

getAnnotation

public <A> A getAnnotation(QName qname)

Description copied from interface: Definition

Returns generic definition annotation. Annotations are a method to extend schema definitions. This may be annotation stored in the schema definition file (e.g. XSD) or it may be a dynamic annotation determined at run-time. Annotation value should be a prism-supported object. E.g. a prims "bean" (JAXB annotated class), prism item, prism value or something like that. EXPERIMENTAL. Hic sunt leones. This may change at any moment. Note: annotations are only partially supported now (3.8). They are somehow transient. E.g. they are not serialized to XSD schema definitions (yet).

Specified by:

getAnnotation in interface Definition

getAnnotations

@Nullable
public @Nullable Map<QName,Object> getAnnotations()

Description copied from interface: Definition

Returns all annotations, as unmodifiable map. Nullable by design, to avoid creating lots of empty maps.

Specified by:

getAnnotations in interface Definition

getSchemaMigrations

public List<SchemaMigration> getSchemaMigrations()

Specified by:

getSchemaMigrations in interface PrismLifecycleDefinition

getDiagrams

public List<ItemDiagramSpecification> getDiagrams()

Specified by:

getDiagrams in interface PrismPresentationDefinition

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

getOldItem

public I getOldItem()

isIndexOnly

public boolean isIndexOnly()

Description copied from interface: PrismItemStorageDefinition

If true, this item is not stored in XML representation in repo. TODO better name

Specified by:

isIndexOnly in interface PrismItemStorageDefinition

getVisibleOverwrite

public UserInterfaceElementVisibilityType getVisibleOverwrite()

Specified by:

getVisibleOverwrite in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

isVisible

public boolean isVisible(PrismContainerValueWrapper<?> parent,
 ItemVisibilityHandler visibilityHandler)

Specified by:

isVisible in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

isVisibleByVisibilityHandler

protected boolean isVisibleByVisibilityHandler(ItemVisibilityHandler visibilityHandler)

remove

public void remove(VW valueWrapper,
 ModelServiceLocator locator)
            throws SchemaException

Specified by:

remove in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

Throws:

SchemaException

removeAll

public void removeAll(ModelServiceLocator locator)
               throws SchemaException

Specified by:

removeAll in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

Throws:

SchemaException

createNewEmptyValue

protected abstract <PV extends PrismValue> PV createNewEmptyValue(ModelServiceLocator locator)

add

public <PV extends PrismValue> void add(PV newValue,
 ModelServiceLocator locator)
                                 throws SchemaException

Specified by:

add in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

Throws:

SchemaException

isMetadata

public boolean isMetadata()

Specified by:

isMetadata in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

setMetadata

public void setMetadata(boolean metadata)

Specified by:

setMetadata in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

setShowMetadataDetails

public void setShowMetadataDetails(boolean showMetadataDetails)

Specified by:

setShowMetadataDetails in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

isShowMetadataDetails

public boolean isShowMetadataDetails()

Specified by:

isShowMetadataDetails in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

isProcessProvenanceMetadata

public boolean isProcessProvenanceMetadata()

Specified by:

isProcessProvenanceMetadata in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

setProcessProvenanceMetadata

public void setProcessProvenanceMetadata(boolean processProvenanceMetadata)

Specified by:

setProcessProvenanceMetadata in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

structuredType

public Optional<ComplexTypeDefinition> structuredType()

Description copied from interface: ItemDefinition

Returns complex type definition of item, if underlying value is possible structured. NOTE: This seems weird, since properties and references are simple values, but actually object reference is serialized as structured value and some of properties are also.

Specified by:

structuredType in interface ItemDefinition<I extends Item<?,?>>

getParentContainerValue

public <C extends Containerable>
PrismContainerValueWrapper<C> getParentContainerValue(Class<? extends C> parentClass)

Specified by:

getParentContainerValue in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

isValidated

public boolean isValidated()

Specified by:

isValidated in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

setValidated

public void setValidated(boolean validated)

Specified by:

setValidated in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

getPreconditionDeltas

public Collection<ExecutedDeltaPostProcessor> getPreconditionDeltas(ModelServiceLocator serviceLocator,
 OperationResult result)
                                                             throws CommonException

Description copied from interface: ItemWrapper

Collect processor with deltas and consumer, that should be processed before basic deltas of showed object

Specified by:

getPreconditionDeltas in interface ItemWrapper<I extends Item<?,?>,VW extends PrismValueWrapper>

Throws:

CommonException

toString

public String toString()

Overrides:

toString in class Object