Package com.evolveum.midpoint.prism

Interface PrismContainerDefinition<C extends Containerable>

All Superinterfaces:
Cloneable, DebugDumpable, Definition, Freezable, ItemDefinition<PrismContainer<C>>, LivePrismItemDefinition, LocalItemDefinitionStore, PrismItemAccessDefinition, PrismItemBasicDefinition, PrismItemStorageDefinition, PrismLifecycleDefinition, PrismPresentationDefinition, Revivable, Serializable, SmartVisitable<Definition>, Visitable<Definition>
All Known Subinterfaces:
ContainerDefinitionDelegator<C>, ObjectDefinitionDelegator<O>, PrismContainerWrapper<C>, PrismObjectDefinition<O>, PrismObjectWrapper<O>, ResourceAttributeContainerDefinition, ResourceAttributeContainerDefinitionDelegator, ShadowAssociationsContainerDefinition, ShadowReferenceAttributeDefinition, ShadowWrapper
All Known Implementing Classes:
AssignmentHolderWrapper, CaseWorkItemTypeWrapper, com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl, PrismContainerWrapperImpl, PrismObjectWrapperImpl, PrismSchemaWrapper, ProfilingClassLoggerContainerWrapperImpl, ResourceAttributeContainerDefinitionImpl, ResourceAttributeMappingWrapper, ResourceWrapper, ShadowAssociationsContainerDefinitionImpl, ShadowAssociationWrapperImpl, ShadowReferenceAttributeDefinitionImpl, ShadowWrapperImpl, ValueMetadataWrapperImpl
public interface PrismContainerDefinition<C extends Containerable> extends ItemDefinition<PrismContainer<C>>, LocalItemDefinitionStore
Definition of a prism container. Note: a lot is delegated to a ComplexTypeDefinition.

  • Method Details

    • getCompileTimeClass

      Class<C> getCompileTimeClass()
      Static (compile-time) class holding the container values. May be null. (Let's not mark it as @Nullable to avoid lots of warnings.)

    • getComplexTypeDefinition

      ComplexTypeDefinition getComplexTypeDefinition()
      Definition of the container values. May be null. (Let's not mark it as @Nullable to avoid lots of warnings.) Note that individual values can hold their own (more specific) complex type definitions.

    • getDefinitions

      @NotNull @NotNull List<? extends ItemDefinition<?>> getDefinitions()
      Returns a list of item definitions in this container. It is intentionally a List because it is ordered. (To provide standard format for serialization.) Usually obtained from ComplexTypeDefinition. So please do not modify the content of the list!
      Specified by:
      getDefinitions in interface LocalItemDefinitionStore

    • getItemNames

      default Collection<ItemName> getItemNames()
      Returns names of items that are defined within this container definition. They do NOT include items that can be put into instantiated container by means of "xsd:any" mechanism.

    • isCompletelyDefined

      default boolean isCompletelyDefined()
      Returns true if the instantiated container can contain only items that are explicitly defined here.

    • getPropertyDefinitions

      List<PrismPropertyDefinition<?>> getPropertyDefinitions()
      Returns set of property definitions. The set contains all property definitions of all types that were parsed. Order of definitions is insignificant. The returned collection is immutable or detached from the source. Don't try to modify it. It may fail or the changes may be lost.

    • createEmptyDelta

      @NotNull @NotNull ContainerDelta<C> 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<C extends Containerable>

    • clone

      @NotNull @NotNull PrismContainerDefinition<C> clone()
      Specified by:
      clone in interface Definition
      Specified by:
      clone in interface ItemDefinition<C extends Containerable>

    • cloneWithNewType

      @NotNull @NotNull PrismContainerDefinition<?> cloneWithNewType(@NotNull @NotNull QName newTypeName, @NotNull @NotNull ComplexTypeDefinition newCtd)
      Changes the type name and definition for this PCD. Use only in special cases.

    • cloneWithNewDefinition

      PrismContainerDefinition<C> cloneWithNewDefinition(QName newItemName, ItemDefinition<?> newDefinition)
      TODO

    • replaceDefinition

      void replaceDefinition(QName itemName, ItemDefinition<?> newDefinition)
      TODO

    • createValue

      PrismContainerValue<C> createValue()
      TODO

    • isEmpty

      boolean isEmpty()
      TODO

    • canRepresent

      boolean canRepresent(@NotNull @NotNull QName type)
      TODO

    • mutator

      PrismContainerDefinition.PrismContainerDefinitionMutator<C> 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<C extends Containerable>

    • getTypeClass

      Class<C> 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

    • 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 interface ItemDefinition<C extends Containerable>

    • isAlwaysUseForEquals

      @Experimental default boolean isAlwaysUseForEquals(QName name)
      Returns true, if item is explicitly specified mentioned to be used for equals

    • getAlwaysUseForEquals

      @Experimental default Collection<QName> getAlwaysUseForEquals()
      Returns list of items which should be always used for equals, even if they are operational, and equivalence strategy does not consider operational data.