Package com.evolveum.midpoint.prism

Interface Definition

All Superinterfaces:
Cloneable, DebugDumpable, Freezable, PrismLifecycleDefinition, PrismPresentationDefinition, Revivable, Serializable, SmartVisitable<Definition>, Visitable<Definition>
All Known Subinterfaces:
ComplexTypeDefinition, ComplexTypeDefinitionDelegator, CompositeObjectDefinition, CompositeObjectDefinitionDelegator, ContainerDefinitionDelegator<C>, DefinitionDelegator, EnumerationTypeDefinition, ItemDefinition<I>, ItemDefinitionDelegator<I>, ItemWrapper<I,VW>, ObjectDefinitionDelegator<O>, PrismContainerDefinition<C>, PrismContainerWrapper<C>, PrismObjectDefinition<O>, PrismObjectWrapper<O>, PrismPropertyDefinition<T>, PrismPropertyWrapper<T>, PrismReferenceDefinition, PrismReferenceWrapper<R>, PropertyDefinitionDelegator<T>, ReferenceDefinitionDelegator, ResourceAttributeContainerDefinition, ResourceAttributeContainerDefinitionDelegator, ResourceAttributeDefinitionDelegator<T>, ResourceAttributeWrapper<T>, ResourceObjectClassDefinition, ResourceObjectClassDefinitionDelegator, ResourceObjectDefinition, ResourceObjectDefinitionDelegator, ResourceObjectTypeDefinition, ResourceObjectTypeDefinitionDelegator, ShadowAssociationsComplexTypeDefinition, ShadowAssociationsContainerDefinition, ShadowAttributeDefinition<SA,R>, ShadowAttributesComplexTypeDefinition, ShadowItemsComplexTypeDefinition, ShadowReferenceAttributeDefinition, ShadowSimpleAttributeDefinition<T>, ShadowWrapper, SimpleTypeDefinition, TypeDefinition, TypeDefinitionDelegator
All Known Implementing Classes:
AbstractResourceObjectDefinitionImpl, AssignmentHolderWrapper, CaseWorkItemTypeWrapper, CompositeObjectDefinitionImpl, com.evolveum.midpoint.prism.impl.DefinitionImpl, ExpressionWrapper, com.evolveum.midpoint.prism.impl.ItemDefinitionImpl, ItemWrapperImpl, NormalizationAwareResourceAttributeDefinition, com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl, PrismContainerWrapperImpl, PrismObjectWrapperImpl, PrismPropertyWrapperImpl, PrismReferenceWrapperImpl, PrismSchemaWrapper, ProfilingClassLoggerContainerWrapperImpl, ProtectedStringTypeWrapperImpl, ResourceAttributeContainerDefinitionImpl, ResourceAttributeMappingWrapper, ResourceAttributeWrapperImpl, ResourceObjectClassDefinitionImpl, ResourceObjectTypeDefinitionImpl, ResourceWrapper, ShadowAssociationsContainerDefinitionImpl, ShadowAssociationWrapperImpl, ShadowAttributeDefinitionImpl, ShadowReferenceAttributeDefinitionImpl, ShadowSimpleAttributeDefinitionImpl, ShadowWrapperImpl, ValueMetadataWrapperImpl
public interface Definition extends PrismPresentationDefinition, PrismLifecycleDefinition, Serializable, DebugDumpable, Revivable, Cloneable, Freezable, SmartVisitable<Definition>
Common interface to access all definitions.

  • Method Details

    • getTypeName

      @NotNull @NotNull QName getTypeName()
      Returns a name of the type for this definition. The type can be part of the compile-time schema or it can be defined at run time. Examples of the former case are types like c:UserType, xsd:string, or even flexible ones like c:ExtensionType or c:ShadowAttributesType. Examples of the latter case are types used in - custom extensions, like ext:LocationsType (where ext = e.g. http://example.com/extension), - resource schema, like ri:inetOrgPerson (ri = http://.../resource/instance-3), - connector schema, like TODO In XML representation that corresponds to the name of the XSD type. Although beware, the run-time types do not have statically defined structure. And the resource and connector-related types may even represent different kinds of objects within different contexts (e.g. two distinct resources both with ri:AccountObjectClass types). Also note that for complex type definitions, the type name serves as a unique identifier. On the other hand, for item definitions, it is just one of its attributes; primary key is item name in that case. The type name should be fully qualified. (TODO reconsider this)
      Returns:
      the type name

    • isRuntimeSchema

      boolean isRuntimeSchema()
      This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g. extension schema, resource schema or connector schema or something like that. I.e. it is not defined statically.

    • isAbstract

      boolean isAbstract()
      For types: is the type abstract so that it should not be instantiated directly? For items: TODO

    • isOptionalCleanup

      boolean isOptionalCleanup()
      Marks item that could be ignored by SCM tools (e.g. Git), or removed before commit.

    • isElaborate

      boolean isElaborate()
      Elaborate items are complicated data structure that may deviate from normal principles of the system. For example elaborate items may not be supported in user interface and may only be manageable by raw edits or a special-purpose tools. Elaborate items may be not fully supported by authorizations, schema tools and so on.

    • getTypeClass

      Class<?> getTypeClass()
      Returns a compile-time class that is used to represent items. E.g. returns String, Integer, subclasses of Objectable and Containerable and so on.

    • getAnnotation

      @Experimental <A> A getAnnotation(QName qname)
      Returns generic definition annotation. Annotations are a method to extend schema definitions. This may be annotation stored in the schema definition file (e.g. XSD) or it may be a dynamic annotation determined at run-time. Annotation value should be a prism-supported object. E.g. a prims "bean" (JAXB annotated class), prism item, prism value or something like that. EXPERIMENTAL. Hic sunt leones. This may change at any moment. Note: annotations are only partially supported now (3.8). They are somehow transient. E.g. they are not serialized to XSD schema definitions (yet).

    • getAnnotations

      @Nullable @Nullable Map<QName,Object> getAnnotations()
      Returns all annotations, as unmodifiable map. Nullable by design, to avoid creating lots of empty maps.

    • getMergerIdentifier

      @Nullable @Nullable String getMergerIdentifier()

    • getMergerInstance

      @Nullable @Nullable ItemMerger getMergerInstance(@NotNull @NotNull MergeStrategy strategy, @Nullable @Nullable OriginMarker originMarker)

    • getNaturalKeyConstituents

      @Nullable @Nullable List<QName> getNaturalKeyConstituents()

    • getNaturalKeyInstance

      @Nullable @Nullable NaturalKeyDefinition getNaturalKeyInstance()

    • clone

      @NotNull @NotNull Definition clone()

    • debugDump

      default String debugDump(int indent, IdentityHashMap<Definition,Object> seen)

    • mutator

      Definition.DefinitionMutator mutator()
      Returns an interface to mutate this definition.

    • getMutabilityFlag

      default String getMutabilityFlag()

    • checkMutableOnExposing

      default void checkMutableOnExposing()