Package com.evolveum.midpoint.prism

Interface ItemDefinition<I extends Item<?,?>>

All Superinterfaces:
Cloneable, DebugDumpable, Definition, Freezable, LivePrismItemDefinition, PrismItemAccessDefinition, PrismItemBasicDefinition, PrismItemStorageDefinition, PrismLifecycleDefinition, PrismPresentationDefinition, Revivable, SchemaLookup.Aware, Serializable, SmartVisitable<Definition>, Visitable<Definition>
All Known Subinterfaces:
ContainerDefinitionDelegator<C>, ItemDefinitionDelegator<I>, ItemWrapper<I,VW>, ObjectDefinitionDelegator<O>, PartiallyMutableItemDefinition<I>, PartiallyMutableItemDefinition.Attribute<T>, PartiallyMutableItemDefinition.Container<C>, PartiallyMutableItemDefinition.Property<T>, PartiallyMutableItemDefinition.Reference, PrismContainerDefinition<C>, PrismContainerWrapper<C>, PrismObjectDefinition<O>, PrismObjectWrapper<O>, PrismPropertyDefinition<T>, PrismPropertyWrapper<T>, PrismReferenceDefinition, PrismReferenceWrapper<R>, PropertyDefinitionDelegator<T>, ReferenceDefinitionDelegator, ResourceAttributeDefinitionDelegator<T>, ResourceAttributeWrapper<T>, ShadowAssociationDefinition, ShadowAssociationsContainerDefinition, ShadowAttributesContainerDefinition, ShadowAttributesContainerDefinitionDelegator, ShadowReferenceAttributeDefinition, ShadowSimpleAttributeDefinition<T>, ShadowWrapper
All Known Implementing Classes:
AssignmentHolderWrapper, AssociationAttributeMappingWrapper, AssociationInboundExpressionWrapper, AssociationMappingExpressionWrapper, AssociationOutboundExpressionWrapper, AuthenticationAttemptWrapper, AuthenticationBehaviorWrapper, CaseWorkItemTypeWrapper, DummyPrismObjectDefinition, ExpressionWrapper, ItemDefinitionImpl, ItemWrapperImpl, NormalizationAwareResourceAttributeDefinition, ObjectTypeAttributeMappingWrapper, PrismContainerDefinitionImpl, PrismContainerWrapperImpl, PrismObjectDefinitionImpl, PrismObjectWrapperImpl, PrismPropertyDefinitionImpl, PrismPropertyWrapperImpl, PrismReferenceDefinitionImpl, PrismReferenceWrapperImpl, PrismSchemaWrapper, ProfilingClassLoggerContainerWrapperImpl, ProtectedStringTypeWrapperImpl, ResourceAttributeWrapperImpl, ResourceWrapper, ShadowAssociationDefinitionImpl, ShadowAssociationsContainerDefinitionImpl, ShadowAssociationValueWrapper, ShadowAssociationWrapperImpl, ShadowAttributesContainerDefinitionImpl, ShadowReferenceAttributeDefinitionImpl, ShadowSimpleAttributeDefinitionImpl, ShadowWrapperImpl, TransformableContainerDefinition, TransformableItemDefinition, TransformableObjectDefinition, TransformablePropertyDefinition, TransformablePropertyDefinition.RefinedAttribute, TransformablePropertyDefinition.ResourceAttribute, TransformableReferenceDefinition, ValueMetadataWrapperImpl
public interface ItemDefinition<I extends Item<?,?>> extends Definition, PrismItemBasicDefinition, PrismItemStorageDefinition, PrismItemAccessDefinition, LivePrismItemDefinition, SchemaLookup.Aware
A definition of a specific item (as opposed to a type).
See Also:

  • Method Details

    • getProcessing

      ItemProcessing getProcessing()

    • isIgnored

      default boolean isIgnored()

    • isOperational

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

    • isAlwaysUseForEquals

      @Experimental boolean isAlwaysUseForEquals()
      Item which should always be used for equals even if it is operational and strategy does not consider operational items. EXPERIMENTAL

    • isInherited

      boolean isInherited()
      Whether the 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.

    • getValueEnumerationRef

      PrismReferenceValue getValueEnumerationRef()
      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.

    • instantiate

      @NotNull I instantiate() throws SchemaException
      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.
      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.
      Throws:
      SchemaException

    • createEmptyDelta

      @NotNull @NotNull ItemDelta<?,?> createEmptyDelta(ItemPath path)
      Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.

    • clone

      @NotNull @NotNull ItemDefinition<I> clone()
      Specified by:
      clone in interface Definition

    • cloneWithNewName

      @NotNull @NotNull ItemDefinition<I> cloneWithNewName(@NotNull @NotNull ItemName itemName)
      Returns a clone of this definition, but with name changed to the provided one.
      See Also:

    • deepClone

      ItemDefinition<I> deepClone(@NotNull @NotNull DeepCloneOperation operation)
      TODO document

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

    • mutator

      ItemDefinition.ItemDefinitionMutator mutator()
      Description copied from interface: Definition
      Returns an interface to mutate this definition.
      Specified by:
      mutator in interface Definition

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