Package com.evolveum.midpoint.prism

Interface ItemDefinition<I extends Item>

    • Method Detail

      • getItemName

        @NotNull
@NotNull ItemName getItemName()

      • getNamespace

        String getNamespace()

      • getMinOccurs

        int getMinOccurs()

      • getMaxOccurs

        int getMaxOccurs()

      • isSingleValue

        default boolean isSingleValue()

      • isMultiValue

        default boolean isMultiValue()

      • isMandatory

        default boolean isMandatory()

      • isOptional

        default boolean isOptional()

      • isOperational

        boolean isOperational()

      • isIndexOnly

        @Experimental
boolean isIndexOnly()
        EXPERIMENTAL. If true, this item is not stored in XML representation in repo. TODO better name

      • isInherited

        boolean isInherited()
        Whether an item is inherited from a supertype.

      • isDynamic

        boolean isDynamic()
        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).

      • getSubstitutionHead

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

      • isHeterogeneousListItem

        @Experimental
boolean isHeterogeneousListItem()
        Can be used in heterogeneous lists as a list item. EXPERIMENTAL.

      • isValidFor

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

      • adoptElementDefinitionFrom

        void adoptElementDefinitionFrom​(ItemDefinition otherDef)

      • instantiate

        @NotNull
I instantiate()
       throws SchemaException
        Create an item instance. Definition name or default name will used as an element name for the instance. The instance will otherwise be empty.
        Returns:
        created item instance
        Throws:
        SchemaException

      • instantiate

        @NotNull
I instantiate​(QName name)
       throws SchemaException
        Create an item instance. Definition name will use provided name. for the instance. The instance will otherwise be empty.
        Returns:
        created item instance
        Throws:
        SchemaException

      • findItemDefinition

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

      • debugDumpShortToString

        void debugDumpShortToString​(StringBuilder sb)
        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.

      • canBeDefinitionOf

        boolean canBeDefinitionOf​(I item)

      • canBeDefinitionOf

        boolean canBeDefinitionOf​(PrismValue pvalue)

      • structuredType

        @Experimental
Optional<ComplexTypeDefinition> structuredType()
        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.
        Returns: