Package com.evolveum.midpoint.prism

Interface ItemDefinition<I extends Item>

    • Method Detail

      • getItemName

        @NotNull
ItemName getItemName()

      • getNamespace

        String getNamespace()

      • getMinOccurs

        int getMinOccurs()

      • getMaxOccurs

        int getMaxOccurs()

      • isSingleValue

        boolean isSingleValue()

      • isMultiValue

        boolean isMultiValue()

      • isMandatory

        boolean isMandatory()

      • isOptional

        boolean isOptional()

      • isOperational

        boolean isOperational()

      • isIndexOnly

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

      • canRead

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

      • canModify

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

      • canAdd

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

      • getSubstitutionHead

        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

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

      • isValidFor

        boolean isValidFor​(@NotNull
                   QName elementQName,
                   @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

      • 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)