Package com.evolveum.midpoint.prism.deleg

Interface ContainerDefinitionDelegator<C extends Containerable>

All Superinterfaces:

Cloneable, DebugDumpable, Definition, DefinitionDelegator, Freezable, ItemDefinition<PrismContainer<C>>, ItemDefinitionDelegator<PrismContainer<C>>, LivePrismItemDefinition, LocalItemDefinitionStore, PrismContainerDefinition<C>, PrismItemAccessDefinition, PrismItemBasicDefinition, PrismItemStorageDefinition, PrismLifecycleDefinition, PrismPresentationDefinition, Revivable, SchemaLookup.Aware, Serializable, SmartVisitable<Definition>, Visitable<Definition>

All Known Subinterfaces:

ObjectDefinitionDelegator<O>, ShadowAttributesContainerDefinitionDelegator

public interface ContainerDefinitionDelegator<C extends Containerable>
extends ItemDefinitionDelegator<PrismContainer<C>>, PrismContainerDefinition<C>

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.Definition

Definition.DefinitionBuilder, Definition.DefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.ItemDefinition

ItemDefinition.ItemDefinitionLikeBuilder, ItemDefinition.ItemDefinitionMutator

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismContainerDefinition

PrismContainerDefinition.PrismContainerDefinitionMutator<C extends Containerable>

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemAccessDefinition

PrismItemAccessDefinition.Data, PrismItemAccessDefinition.Delegable, PrismItemAccessDefinition.Info, PrismItemAccessDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemBasicDefinition

PrismItemBasicDefinition.Data, PrismItemBasicDefinition.Delegable, PrismItemBasicDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismItemStorageDefinition

PrismItemStorageDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismLifecycleDefinition

PrismLifecycleDefinition.Data, PrismLifecycleDefinition.Delegable, PrismLifecycleDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.prism.PrismPresentationDefinition

PrismPresentationDefinition.Data, PrismPresentationDefinition.Delegable, PrismPresentationDefinition.Mutable

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
default boolean	canRepresent(@NotNull QName type)	TODO
default PrismContainerDefinition<C>	cloneWithNewDefinition(QName newItemName, ItemDefinition<?> newDefinition)	TODO
default @NotNull ContainerDelta<C>	createEmptyDelta(ItemPath path)	Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.
default PrismContainerValue<C>	createValue()	TODO
PrismContainerDefinition<C>	delegate()
default <C2 extends Containerable> PrismContainerDefinition<C2>	findContainerDefinition(@NotNull ItemPath path)	Returns PrismContainerDefinition corresponding to given path (rooted at this store).
default <T extends ItemDefinition<?>> T	findItemDefinition(@NotNull ItemPath path, @NotNull Class<T> clazz)	Used to find a matching item definition _within_ this definition.
default Class<C>	getCompileTimeClass()	Static (compile-time) class holding the container values.
default ComplexTypeDefinition	getComplexTypeDefinition()	Definition of the container values.
default @NotNull List<? extends ItemDefinition<?>>	getDefinitions()	Returns a list of item definitions in this container.
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 Collection<ItemName>	getItemNames()	Returns names of items that are defined within this container definition.
default List<PrismPropertyDefinition<?>>	getPropertyDefinitions()	Returns set of property definitions.
default Class<C>	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	isEmphasized()	True for definitions that are more important than others and that should be emphasized during presentation.
default boolean	isEmpty()	TODO
default void	replaceDefinition(QName itemName, ItemDefinition<?> newDefinition)	TODO
default Optional<ComplexTypeDefinition>	structuredType()	Returns complex type definition of item, if underlying value is possible structured.

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

checkMutableOnExposing

Methods inherited from interface com.evolveum.midpoint.prism.deleg.DefinitionDelegator

accept, accept, debugDump, debugDump, debugDump, debugDumpLazily, debugDumpLazily, getAnnotation, getAnnotations, getDeprecatedSince, getDisplayHint, getDocumentation, getDocumentationPreview, getMergerIdentifier, getMergerInstance, getMutabilityFlag, getNaturalKeyConstituents, getNaturalKeyInstance, getPlannedRemoval, getRemovedSince, getSchemaContextDefinition, getSchemaMigrations, isAbstract, isDeprecated, isElaborate, isExperimental, isOptionalCleanup, isRemoved, isRuntimeSchema

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

checkImmutable, checkMutable, freeze, isImmutable

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

cloneWithNewName, getProcessing, isAlwaysUseForEquals, isIgnored

Methods inherited from interface com.evolveum.midpoint.prism.deleg.ItemDefinitionDelegator

canAdd, canModify, canRead, debugDumpShortToString, deepClone, getDiagrams, getHelp, getItemName, getMaxOccurs, getMinOccurs, getSubstitutionHead, getValueEnumerationRef, instantiate, instantiate, isDynamic, isHeterogeneousListItem, isIndexed, isIndexOnly, isInherited, isOperational, isSearchable, isValidFor

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

containsItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findLocalItemDefinitionByIteration, findPropertyDefinition, findReferenceDefinition

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

clone, cloneWithNewType, getAlwaysUseForEquals, isAlwaysUseForEquals, isCompletelyDefined, mutator, schemaLookup

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

getInfo

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

isMandatory, isMultiValue, isOptional, isSingleValue

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

revive

Method Details

delegate

PrismContainerDefinition<C> delegate()

Specified by:

delegate in interface DefinitionDelegator

Specified by:

delegate in interface ItemDefinitionDelegator<C extends Containerable>

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 interface Definition

Specified by:

getTypeName in interface DefinitionDelegator

Specified by:

getTypeName in interface ItemDefinitionDelegator<C extends Containerable>

Specified by:

getTypeName in interface PrismItemBasicDefinition

Returns:

the type name

getDisplayName

default String getDisplayName()

Description copied from interface: PrismPresentationDefinition

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 interface DefinitionDelegator

Specified by:

getDisplayName in interface PrismPresentationDefinition

Returns:

display name string or catalog key

getDisplayOrder

default Integer getDisplayOrder()

Description copied from interface: PrismPresentationDefinition

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 interface DefinitionDelegator

Specified by:

getDisplayOrder in interface PrismPresentationDefinition

isEmphasized

default boolean isEmphasized()

Description copied from interface: PrismPresentationDefinition

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. TODO probably deprecated, isn't it?

Specified by:

isEmphasized in interface DefinitionDelegator

Specified by:

isEmphasized in interface PrismPresentationDefinition

getCompileTimeClass

default Class<C> getCompileTimeClass()

Description copied from interface: PrismContainerDefinition

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

Specified by:

getCompileTimeClass in interface PrismContainerDefinition<C extends Containerable>

getComplexTypeDefinition

default ComplexTypeDefinition getComplexTypeDefinition()

Description copied from interface: PrismContainerDefinition

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.

Specified by:

getComplexTypeDefinition in interface PrismContainerDefinition<C extends Containerable>

getDefinitions

@NotNull
default @NotNull List<? extends ItemDefinition<?>> getDefinitions()

Description copied from interface: PrismContainerDefinition

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

Specified by:

getDefinitions in interface PrismContainerDefinition<C extends Containerable>

getItemNames

default Collection<ItemName> getItemNames()

Description copied from interface: PrismContainerDefinition

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.

Specified by:

getItemNames in interface PrismContainerDefinition<C extends Containerable>

getPropertyDefinitions

default List<PrismPropertyDefinition<?>> getPropertyDefinitions()

Description copied from interface: PrismContainerDefinition

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.

Specified by:

getPropertyDefinitions in interface PrismContainerDefinition<C extends Containerable>

findItemDefinition

default <T extends ItemDefinition<?>> T findItemDefinition(@NotNull
 @NotNull ItemPath path,
 @NotNull
 @NotNull Class<T> clazz)

Description copied from interface: LivePrismItemDefinition

Used to find a matching item definition _within_ this definition. Treats e.g. de-referencing in prism references.

Specified by:

findItemDefinition in interface ItemDefinitionDelegator<C extends Containerable>

Specified by:

findItemDefinition in interface LivePrismItemDefinition

Specified by:

findItemDefinition in interface LocalItemDefinitionStore

cloneWithNewDefinition

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

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

cloneWithNewDefinition in interface PrismContainerDefinition<C extends Containerable>

replaceDefinition

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

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

replaceDefinition in interface PrismContainerDefinition<C extends Containerable>

createValue

default PrismContainerValue<C> createValue()

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

createValue in interface PrismContainerDefinition<C extends Containerable>

isEmpty

default boolean isEmpty()

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

isEmpty in interface PrismContainerDefinition<C extends Containerable>

canRepresent

default boolean canRepresent(@NotNull
 @NotNull QName type)

Description copied from interface: PrismContainerDefinition

TODO

Specified by:

canRepresent in interface PrismContainerDefinition<C extends Containerable>

findContainerDefinition

default <C2 extends Containerable>
PrismContainerDefinition<C2> findContainerDefinition(@NotNull
 @NotNull ItemPath path)

Description copied from interface: LocalItemDefinitionStore

Returns PrismContainerDefinition corresponding to given path (rooted at this store). Tries the global resolution in the case of "any" content.

Specified by:

findContainerDefinition in interface LocalItemDefinitionStore

createEmptyDelta

@NotNull
default @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>

Specified by:

createEmptyDelta in interface ItemDefinitionDelegator<C extends Containerable>

Specified by:

createEmptyDelta in interface PrismContainerDefinition<C extends Containerable>

getTypeClass

default 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

Specified by:

getTypeClass in interface DefinitionDelegator

Specified by:

getTypeClass in interface PrismContainerDefinition<C extends Containerable>

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>

Specified by:

structuredType in interface ItemDefinitionDelegator<C extends Containerable>

Specified by:

structuredType in interface PrismContainerDefinition<C extends Containerable>