Interface ItemDefinitionDelegator<I extends Item<?,?>>
-
- All Superinterfaces:
Cloneable
,DebugDumpable
,Definition
,DefinitionDelegator
,Freezable
,ItemDefinition<I>
,PrismContextSensitive
,PrismItemAccessDefinition
,Revivable
,Serializable
,SmartVisitable<Definition>
,Visitable<Definition>
- All Known Subinterfaces:
AttributeContainerDefinitionDelegator
,AttributeDefinitionDelegator<T>
,ContainerDefinitionDelegator<C>
,ObjectDefinitionDelegator<O>
,PropertyDefinitionDelegator<T>
,ReferenceDefinitionDelegator
,RefinedAttributeDefinitionDelegator<T>
- All Known Implementing Classes:
TransformableContainerDefinition
,TransformableContainerDefinition.AttributeContainer
,TransformableItemDefinition
,TransformableObjectDefinition
,TransformablePropertyDefinition
,TransformablePropertyDefinition.RefinedAttribute
,TransformablePropertyDefinition.ResourceAttribute
,TransformableReferenceDefinition
public interface ItemDefinitionDelegator<I extends Item<?,?>> extends DefinitionDelegator, ItemDefinition<I>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition
PrismItemAccessDefinition.Mutable
-
-
Field Summary
-
Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable
INDENT_STRING
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
adoptElementDefinitionFrom(ItemDefinition otherDef)
default boolean
canAdd()
Returns true if this item can be added: it can be part of an object that is created.default boolean
canBeDefinitionOf(PrismValue pvalue)
default boolean
canBeDefinitionOf(I item)
default boolean
canModify()
Returns true if this item can be modified (updated).default boolean
canRead()
Returns true if this item can be read (displayed).default ItemDelta
createEmptyDelta(ItemPath path)
default void
debugDumpShortToString(StringBuilder sb)
Used in debugDumping items.default ItemDefinition<I>
deepClone(boolean ultraDeep, Consumer<ItemDefinition> postCloneAction)
default ItemDefinition<I>
deepClone(Map<QName,ComplexTypeDefinition> ctdMap, Map<QName,ComplexTypeDefinition> onThisPath, Consumer<ItemDefinition> postCloneAction)
ItemDefinition<I>
delegate()
default <T extends ItemDefinition>
TfindItemDefinition(@NotNull ItemPath path, @NotNull Class<T> clazz)
default List<ItemDiagramSpecification>
getDiagrams()
default @NotNull ItemName
getItemName()
default int
getMaxOccurs()
default int
getMinOccurs()
default String
getNamespace()
default QName
getSubstitutionHead()
Returns the name of an element this one can be substituted for (e.g.default PrismReferenceValue
getValueEnumerationRef()
default I
instantiate()
Create an item instance.default I
instantiate(QName name)
Create an item instance.default boolean
isDynamic()
Returns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML.default boolean
isHeterogeneousListItem()
Can be used in heterogeneous lists as a list item.default boolean
isIndexOnly()
EXPERIMENTAL.default boolean
isInherited()
Whether an item is inherited from a supertype.default boolean
isMandatory()
default boolean
isOperational()
default boolean
isOptional()
default boolean
isValidFor(@NotNull QName elementQName, @NotNull Class<? extends ItemDefinition> clazz, boolean caseInsensitive)
default boolean
isValidFor(QName elementQName, Class<? extends ItemDefinition> clazz)
default Optional<ComplexTypeDefinition>
structuredType()
Returns complex type definition of item, if underlying value is possible structured.-
Methods inherited from interface com.evolveum.midpoint.prism.deleg.DefinitionDelegator
accept, accept, debugDump, debugDump, debugDump, debugDumpLazily, debugDumpLazily, getAnnotation, getDeprecatedSince, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getPrismContext, getProcessing, getSchemaMigrations, getSchemaRegistry, getTypeClass, getTypeClassIfKnown, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRuntimeSchema, setAnnotation
-
Methods inherited from interface com.evolveum.midpoint.prism.Freezable
checkImmutable, checkMutable, freeze, isImmutable
-
Methods inherited from interface com.evolveum.midpoint.prism.ItemDefinition
clone, isMultiValue, isSingleValue, revive, toMutable
-
-
-
-
Method Detail
-
delegate
ItemDefinition<I> delegate()
- Specified by:
delegate
in interfaceDefinitionDelegator
-
canRead
default 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 interfacePrismItemAccessDefinition
-
getItemName
@NotNull default @NotNull ItemName getItemName()
- Specified by:
getItemName
in interfaceItemDefinition<I extends Item<?,?>>
-
getNamespace
default String getNamespace()
- Specified by:
getNamespace
in interfaceItemDefinition<I extends Item<?,?>>
-
getMinOccurs
default int getMinOccurs()
- Specified by:
getMinOccurs
in interfaceItemDefinition<I extends Item<?,?>>
-
getMaxOccurs
default int getMaxOccurs()
- Specified by:
getMaxOccurs
in interfaceItemDefinition<I extends Item<?,?>>
-
isMandatory
default boolean isMandatory()
- Specified by:
isMandatory
in interfaceItemDefinition<I extends Item<?,?>>
-
isOptional
default boolean isOptional()
- Specified by:
isOptional
in interfaceItemDefinition<I extends Item<?,?>>
-
isOperational
default boolean isOperational()
- Specified by:
isOperational
in interfaceItemDefinition<I extends Item<?,?>>
-
isIndexOnly
default boolean isIndexOnly()
Description copied from interface:ItemDefinition
EXPERIMENTAL. If true, this item is not stored in XML representation in repo. TODO better name- Specified by:
isIndexOnly
in interfaceItemDefinition<I extends Item<?,?>>
-
canModify
default 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 interfacePrismItemAccessDefinition
-
isInherited
default boolean isInherited()
Description copied from interface:ItemDefinition
Whether an item is inherited from a supertype.- Specified by:
isInherited
in interfaceItemDefinition<I extends Item<?,?>>
-
isDynamic
default 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 interfaceItemDefinition<I extends Item<?,?>>
-
canAdd
default 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 interfacePrismItemAccessDefinition
-
getDiagrams
default List<ItemDiagramSpecification> getDiagrams()
- Specified by:
getDiagrams
in interfaceDefinition
-
getSubstitutionHead
default 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 interfaceItemDefinition<I extends Item<?,?>>
-
isHeterogeneousListItem
default boolean isHeterogeneousListItem()
Description copied from interface:ItemDefinition
Can be used in heterogeneous lists as a list item. EXPERIMENTAL.- Specified by:
isHeterogeneousListItem
in interfaceItemDefinition<I extends Item<?,?>>
-
getValueEnumerationRef
default PrismReferenceValue getValueEnumerationRef()
- Specified by:
getValueEnumerationRef
in interfaceItemDefinition<I extends Item<?,?>>
-
isValidFor
default boolean isValidFor(QName elementQName, Class<? extends ItemDefinition> clazz)
- Specified by:
isValidFor
in interfaceItemDefinition<I extends Item<?,?>>
-
isValidFor
default boolean isValidFor(@NotNull @NotNull QName elementQName, @NotNull @NotNull Class<? extends ItemDefinition> clazz, boolean caseInsensitive)
- Specified by:
isValidFor
in interfaceItemDefinition<I extends Item<?,?>>
-
adoptElementDefinitionFrom
default void adoptElementDefinitionFrom(ItemDefinition otherDef)
- Specified by:
adoptElementDefinitionFrom
in interfaceItemDefinition<I extends Item<?,?>>
-
instantiate
@NotNull default I instantiate() throws SchemaException
Description copied from interface:ItemDefinition
Create an item instance. Definition name or default name will used as an element name for the instance. The instance will otherwise be empty.- Specified by:
instantiate
in interfaceItemDefinition<I extends Item<?,?>>
- Returns:
- created item instance
- Throws:
SchemaException
-
instantiate
@NotNull default 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 interfaceItemDefinition<I extends Item<?,?>>
- Returns:
- created item instance
- Throws:
SchemaException
-
findItemDefinition
default <T extends ItemDefinition> T findItemDefinition(@NotNull @NotNull ItemPath path, @NotNull @NotNull Class<T> clazz)
- Specified by:
findItemDefinition
in interfaceItemDefinition<I extends Item<?,?>>
-
createEmptyDelta
default ItemDelta createEmptyDelta(ItemPath path)
- Specified by:
createEmptyDelta
in interfaceItemDefinition<I extends Item<?,?>>
-
deepClone
default ItemDefinition<I> deepClone(boolean ultraDeep, Consumer<ItemDefinition> postCloneAction)
- Specified by:
deepClone
in interfaceItemDefinition<I extends Item<?,?>>
-
deepClone
default ItemDefinition<I> deepClone(Map<QName,ComplexTypeDefinition> ctdMap, Map<QName,ComplexTypeDefinition> onThisPath, Consumer<ItemDefinition> postCloneAction)
- Specified by:
deepClone
in interfaceItemDefinition<I extends Item<?,?>>
-
debugDumpShortToString
default 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 interfaceItemDefinition<I extends Item<?,?>>
-
canBeDefinitionOf
default boolean canBeDefinitionOf(I item)
- Specified by:
canBeDefinitionOf
in interfaceItemDefinition<I extends Item<?,?>>
-
canBeDefinitionOf
default boolean canBeDefinitionOf(PrismValue pvalue)
- Specified by:
canBeDefinitionOf
in interfaceItemDefinition<I extends Item<?,?>>
-
structuredType
default 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 interfaceItemDefinition<I extends Item<?,?>>
- Returns:
-
-