Interface DefinitionDelegator
-
- All Superinterfaces:
Cloneable
,DebugDumpable
,Definition
,Freezable
,PrismContextSensitive
,Revivable
,Serializable
,SmartVisitable<Definition>
,Visitable<Definition>
- All Known Subinterfaces:
AttributeContainerDefinitionDelegator
,AttributeDefinitionDelegator<T>
,ComplexTypeDefinitionDelegator
,CompositeObjectDefinitionDelegator
,ContainerDefinitionDelegator<C>
,ItemDefinitionDelegator<I>
,ObjectDefinitionDelegator<O>
,PropertyDefinitionDelegator<T>
,ReferenceDefinitionDelegator
,RefinedAttributeDefinitionDelegator<T>
,ResourceObjectClassDefinitionDelegator
,ResourceObjectDefinitionDelegator
,ResourceObjectTypeDefinitionDelegator
,TypeDefinitionDelegator
public interface DefinitionDelegator extends Definition
-
-
Field Summary
-
Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable
INDENT_STRING
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
accept(Visitor<Definition> visitor)
default boolean
accept(Visitor<Definition> visitor, SmartVisitation<Definition> visitation)
default String
debugDump()
Show the content of the object intended for diagnostics by system administrator.default String
debugDump(int indent)
default String
debugDump(int indent, IdentityHashMap<Definition,Object> seen)
default Object
debugDumpLazily()
default Object
debugDumpLazily(int indent)
Definition
delegate()
default <A> A
getAnnotation(QName qname)
Returns generic definition annotation.default @Nullable Map<QName,Object>
getAnnotations()
Returns all annotations, as unmodifiable map.default String
getDeprecatedSince()
default String
getDisplayName()
Returns display name.default Integer
getDisplayOrder()
Specifies an order in which the item should be displayed relative to other items at the same level.default String
getDocumentation()
default String
getDocumentationPreview()
Returns only a first sentence of documentation.default String
getHelp()
Returns help string.default String
getMutabilityFlag()
default String
getPlannedRemoval()
Version of data model in which the item is likely to be removed.default PrismContext
getPrismContext()
default ItemProcessing
getProcessing()
Level of processing (ignore, minimal, auto, full) for this item/type.default List<SchemaMigration>
getSchemaMigrations()
default SchemaRegistry
getSchemaRegistry()
default Class<?>
getTypeClass()
Returns a compile-time class that is used to represent items.default @NotNull QName
getTypeName()
Returns a name of the type for this definition.default boolean
isAbstract()
For types: is the type abstract so that it should not be instantiated directly? For items: TODOdefault boolean
isDeprecated()
default boolean
isElaborate()
Elaborate items are complicated data structure that may deviate from normal principles of the system.default boolean
isEmphasized()
True for definitions that are more important than others and that should be emphasized during presentation.default boolean
isExperimental()
Experimental functionality is not stable and it may be changed in any future release without any warning.default boolean
isIgnored()
Item definition that has this flag set should be ignored by any processing.default boolean
isRuntimeSchema()
This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.default <A> void
setAnnotation(QName qname, A value)
-
Methods inherited from interface com.evolveum.midpoint.prism.Definition
clone, getDiagrams, toMutable
-
Methods inherited from interface com.evolveum.midpoint.prism.Freezable
checkImmutable, checkMutable, freeze, isImmutable
-
-
-
-
Method Detail
-
delegate
Definition delegate()
-
getPrismContext
default PrismContext getPrismContext()
- Specified by:
getPrismContext
in interfacePrismContextSensitive
-
accept
default void accept(Visitor<Definition> visitor)
- Specified by:
accept
in interfaceVisitable<Definition>
-
debugDump
default String debugDump()
Description copied from interface:DebugDumpable
Show the content of the object intended for diagnostics by system administrator. The out put should be suitable to use in system logs at "debug" level. It may be multi-line, but in that case it should be well indented and quite terse. As it is intended to be used by system administrator, it should not use any developer terms such as class names, exceptions or stack traces.- Specified by:
debugDump
in interfaceDebugDumpable
- Returns:
- content of the object intended for diagnostics by system administrator.
-
accept
default boolean accept(Visitor<Definition> visitor, SmartVisitation<Definition> visitation)
- Specified by:
accept
in interfaceSmartVisitable<Definition>
- Returns:
- false if we already was here
-
getTypeName
@NotNull default @NotNull QName getTypeName()
Description copied from interface:Definition
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)- Specified by:
getTypeName
in interfaceDefinition
- Returns:
- the type name
-
debugDump
default String debugDump(int indent)
- Specified by:
debugDump
in interfaceDebugDumpable
-
debugDumpLazily
default Object debugDumpLazily()
- Specified by:
debugDumpLazily
in interfaceDebugDumpable
-
debugDumpLazily
default Object debugDumpLazily(int indent)
- Specified by:
debugDumpLazily
in interfaceDebugDumpable
-
isRuntimeSchema
default boolean isRuntimeSchema()
Description copied from interface:Definition
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.- Specified by:
isRuntimeSchema
in interfaceDefinition
-
isIgnored
default boolean isIgnored()
Description copied from interface:Definition
Item definition that has this flag set should be ignored by any processing. The ignored item is still part of the schema. Item instances may appear in the serialized data formats (e.g. XML) or data store and the parser should not raise an error if it encounters them. But any high-level processing code should ignore presence of this item. E.g. it should not be displayed to the user, should not be present in transformed data structures, etc. Note that the same item can be ignored at higher layer (e.g. presentation) but not ignored at lower layer (e.g. model). This works by presenting different item definitions for these layers (see LayerRefinedAttributeDefinition). Semantics of this flag for complex type definitions is to be defined yet.- Specified by:
isIgnored
in interfaceDefinition
-
getProcessing
default ItemProcessing getProcessing()
Description copied from interface:Definition
Level of processing (ignore, minimal, auto, full) for this item/type.- Specified by:
getProcessing
in interfaceDefinition
-
isAbstract
default boolean isAbstract()
Description copied from interface:Definition
For types: is the type abstract so that it should not be instantiated directly? For items: TODO- Specified by:
isAbstract
in interfaceDefinition
-
isDeprecated
default boolean isDeprecated()
- Specified by:
isDeprecated
in interfaceDefinition
-
isExperimental
default boolean isExperimental()
Description copied from interface:Definition
Experimental functionality is not stable and it may be changed in any future release without any warning. Use at your own risk.- Specified by:
isExperimental
in interfaceDefinition
-
getPlannedRemoval
default String getPlannedRemoval()
Description copied from interface:Definition
Version of data model in which the item is likely to be removed. This annotation is used for deprecated item to indicate imminent incompatibility in future versions of data model.- Specified by:
getPlannedRemoval
in interfaceDefinition
-
isElaborate
default boolean isElaborate()
Description copied from interface:Definition
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.- Specified by:
isElaborate
in interfaceDefinition
-
getDeprecatedSince
default String getDeprecatedSince()
- Specified by:
getDeprecatedSince
in interfaceDefinition
-
isEmphasized
default boolean isEmphasized()
Description copied from interface:Definition
True for definitions that are more important than others and that should be emphasized during presentation. E.g. the emphasized definitions will always be displayed in the user interfaces (even if they are empty), they will always be included in the dumps, etc.- Specified by:
isEmphasized
in interfaceDefinition
-
getDisplayName
default String getDisplayName()
Description copied from interface:Definition
Returns display name. Specifies the printable name of the object class or attribute. It must contain a printable string. It may also contain a key to catalog file. Returns null if no display name is set. Corresponds to "displayName" XSD annotation.- Specified by:
getDisplayName
in interfaceDefinition
- Returns:
- display name string or catalog key
-
getDisplayOrder
default Integer getDisplayOrder()
Description copied from interface:Definition
Specifies an order in which the item should be displayed relative to other items at the same level. The items will be displayed by sorting them by the values of displayOrder annotation (ascending). Items that do not have any displayOrder annotation will be displayed last. The ordering of values with the same displayOrder is undefined and it may be arbitrary.- Specified by:
getDisplayOrder
in interfaceDefinition
-
getHelp
default String getHelp()
Description copied from interface:Definition
Returns help string. Specifies the help text or a key to catalog file for a help text. The help text may be displayed in any suitable way by the GUI. It should explain the meaning of an attribute or object class. Returns null if no help string is set. Corresponds to "help" XSD annotation.- Specified by:
getHelp
in interfaceDefinition
- Returns:
- help string or catalog key
-
getDocumentation
default String getDocumentation()
- Specified by:
getDocumentation
in interfaceDefinition
-
getDocumentationPreview
default String getDocumentationPreview()
Description copied from interface:Definition
Returns only a first sentence of documentation.- Specified by:
getDocumentationPreview
in interfaceDefinition
-
getSchemaRegistry
default SchemaRegistry getSchemaRegistry()
- Specified by:
getSchemaRegistry
in interfaceDefinition
-
getTypeClass
default Class<?> 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 interfaceDefinition
-
getAnnotation
default <A> A getAnnotation(QName qname)
Description copied from interface:Definition
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).- Specified by:
getAnnotation
in interfaceDefinition
-
getAnnotations
@Nullable default @Nullable Map<QName,Object> getAnnotations()
Description copied from interface:Definition
Returns all annotations, as unmodifiable map. Nullable by design, to avoid creating lots of empty maps.- Specified by:
getAnnotations
in interfaceDefinition
-
setAnnotation
default <A> void setAnnotation(QName qname, A value)
- Specified by:
setAnnotation
in interfaceDefinition
-
getSchemaMigrations
default List<SchemaMigration> getSchemaMigrations()
- Specified by:
getSchemaMigrations
in interfaceDefinition
-
debugDump
default String debugDump(int indent, IdentityHashMap<Definition,Object> seen)
- Specified by:
debugDump
in interfaceDefinition
-
getMutabilityFlag
default String getMutabilityFlag()
- Specified by:
getMutabilityFlag
in interfaceDefinition
-
-