com.evolveum.midpoint.prism

Interface Definition

All Superinterfaces:

Cloneable, DebugDumpable, Revivable, Serializable

All Known Subinterfaces:

ComplexTypeDefinition, CompositeRefinedObjectClassDefinition, ItemDefinition<I>, LayerRefinedAttributeDefinition<T>, LayerRefinedObjectClassDefinition, MutableComplexTypeDefinition, MutableDefinition, MutableItemDefinition<I>, MutableObjectClassComplexTypeDefinition, MutablePrismContainerDefinition<C>, MutablePrismPropertyDefinition<T>, MutablePrismReferenceDefinition, MutableResourceAttributeDefinition<T>, MutableTypeDefinition, ObjectClassComplexTypeDefinition, PrismContainerDefinition<C>, PrismObjectDefinition<O>, PrismPropertyDefinition<T>, PrismReferenceDefinition, RefinedAttributeDefinition<T>, RefinedObjectClassDefinition, ResourceAttributeContainerDefinition, ResourceAttributeDefinition<T>, SimpleTypeDefinition, TypeDefinition

All Known Implementing Classes:

com.evolveum.midpoint.prism.impl.ComplexTypeDefinitionImpl, CompositeRefinedObjectClassDefinitionImpl, com.evolveum.midpoint.prism.impl.DefinitionImpl, com.evolveum.midpoint.prism.impl.ItemDefinitionImpl, LayerRefinedAttributeDefinitionImpl, LayerRefinedObjectClassDefinitionImpl, ObjectClassComplexTypeDefinitionImpl, com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl, com.evolveum.midpoint.prism.impl.PrismPropertyDefinitionImpl, RefinedAttributeDefinitionImpl, RefinedObjectClassDefinitionImpl, ResourceAttributeContainerDefinitionImpl, ResourceAttributeDefinitionImpl, com.evolveum.midpoint.prism.impl.TypeDefinitionImpl

public interface Definition
extends Serializable, DebugDumpable, Revivable, Cloneable

Field Summary

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Method Summary

Modifier and Type	Method and Description
Definition	clone()
default String	debugDump(int indent, IdentityHashMap<Definition,Object> seen)
<A> A	getAnnotation(QName qname) Returns generic definition annotation.
String	getDeprecatedSince()
String	getDisplayName() Returns display name.
Integer	getDisplayOrder() Specifies an order in which the item should be displayed relative to other items at the same level.
String	getDocumentation()
String	getDocumentationPreview() Returns only a first sentence of documentation.
String	getHelp() Returns help string.
String	getPlannedRemoval() Version of data model in which the item is likely to be removed.
PrismContext	getPrismContext()
ItemProcessing	getProcessing()
List<SchemaMigration>	getSchemaMigrations()
default SchemaRegistry	getSchemaRegistry()
Class	getTypeClass() Returns a compile-time class that is used to represent items.
Class	getTypeClassIfKnown()
QName	getTypeName() Returns a name of the type for this definition.
boolean	isAbstract()
boolean	isDeprecated()
boolean	isElaborate() Elaborate items are complicated data structure that may deviate from normal principles of the system.
boolean	isEmphasized() True for definitions that are more important than others and that should be emphasized during presentation.
boolean	isExperimental() Experimental functionality is not stable and it may be changed in any future release without any warning.
boolean	isIgnored() Deprecated.
boolean	isRuntimeSchema() This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.
<A> void	setAnnotation(QName qname, A value)
MutableDefinition	toMutable()

Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable

debugDump, debugDump, debugDumpLazily, debugDumpLazily

Methods inherited from interface com.evolveum.midpoint.prism.Revivable

revive

Method Detail

getTypeName

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

isIgnored

@Deprecated
boolean isIgnored()

Deprecated.

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.

getProcessing

ItemProcessing getProcessing()

isAbstract

boolean isAbstract()

isDeprecated

boolean isDeprecated()

isExperimental

boolean isExperimental()

Experimental functionality is not stable and it may be changed in any future release without any warning. Use at your own risk.

getPlannedRemoval

String getPlannedRemoval()

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.

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.

getDeprecatedSince

String getDeprecatedSince()

isEmphasized

boolean isEmphasized()

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.

getDisplayName

String getDisplayName()

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.

Returns:

display name string or catalog key

getDisplayOrder

Integer getDisplayOrder()

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.

getHelp

String getHelp()

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.

Returns:

help string or catalog key

getDocumentation

String getDocumentation()

getDocumentationPreview

String getDocumentationPreview()

Returns only a first sentence of documentation.

getPrismContext

@Contract(pure=true)
PrismContext getPrismContext()

getSchemaRegistry

default SchemaRegistry getSchemaRegistry()

getTypeClassIfKnown

Class getTypeClassIfKnown()

getTypeClass

Class getTypeClass()

Returns a compile-time class that is used to represent items. E.g. returns String, Integer, sublcasses of Objectable and Containerable and so on.

getAnnotation

<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-suported object. E.g. a prims "bean" (JAXB annotated class), prism item, prism value or something like that. EXPERIMENTAL. Hic sunt liones. 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).

setAnnotation

<A> void setAnnotation(QName qname,
                       A value)

getSchemaMigrations

List<SchemaMigration> getSchemaMigrations()

clone

@NotNull
Definition clone()

debugDump

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

toMutable

MutableDefinition toMutable()