Package com.evolveum.midpoint.schema.processor.deleg

Interface ObjectClassTypeDefinitionDelegator

All Superinterfaces:

Cloneable, ComplexTypeDefinition, ComplexTypeDefinitionDelegator, DebugDumpable, Definition, DefinitionDelegator, Freezable, LocalDefinitionStore, ObjectClassComplexTypeDefinition, PrismContextSensitive, Revivable, Serializable, SmartVisitable<Definition>, TypeDefinition, TypeDefinitionDelegator, Visitable<Definition>

public interface ObjectClassTypeDefinitionDelegator
extends ComplexTypeDefinitionDelegator, ObjectClassComplexTypeDefinition

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
default ObjectQuery	createShadowSearchQuery(String resourceOid)
ObjectClassComplexTypeDefinition	delegate()
default <X> ResourceAttributeDefinition<X>	findAttributeDefinition(String name)
default <X> @Nullable ResourceAttributeDefinition<X>	findAttributeDefinition(QName name)	Finds a attribute definition by looking at the property name.
default <X> @Nullable ResourceAttributeDefinition<X>	findAttributeDefinition(QName name, boolean caseInsensitive)	Finds a attribute definition by looking at the property name; not considering the case.
default Collection<? extends ResourceAttributeDefinition<?>>	getAllIdentifiers()	Returns both primary and secondary identifiers.
default @NotNull Collection<? extends ResourceAttributeDefinition<?>>	getAttributeDefinitions()	Returns all attribute definitions as an unmodifiable collection.
default <X> ResourceAttributeDefinition<X>	getDescriptionAttribute()	Returns the definition of description attribute of a resource object.
default <X> ResourceAttributeDefinition<X>	getDisplayNameAttribute()	Returns the definition of display name attribute.
default String	getIntent()	TODO: THIS SHOULD NOT BE HERE
default ShadowKindType	getKind()	TODO: THIS SHOULD NOT BE HERE
default <X> ResourceAttributeDefinition<X>	getNamingAttribute()	TODO
default String	getNativeObjectClass()	Returns the native object class string for the resource object.
default @NotNull Collection<? extends ResourceAttributeDefinition<?>>	getPrimaryIdentifiers()	Returns the definition of primary identifier attributes of a resource object.
default @NotNull Collection<? extends ResourceAttributeDefinition<?>>	getSecondaryIdentifiers()	Returns the definition of secondary identifier attributes of a resource object.
default ResourceAttributeContainer	instantiate(QName elementName)
default boolean	isAuxiliary()	TODO
default boolean	isDefaultInAKind()	Indicates whether definition is should be used as default definition in ist kind.
default boolean	isPrimaryIdentifier(QName attrName)	Returns true if the attribute with a given name is among primary identifiers.
default boolean	isSecondaryIdentifier(QName attrName)	Returns true if the attribute with a given name is among secondary identifiers.
default boolean	matches(ShadowType shadow)	Deprecated.
default ResourceAttributeContainerDefinition	toResourceAttributeContainerDefinition()
default ResourceAttributeContainerDefinition	toResourceAttributeContainerDefinition(QName elementName)

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

isItemDefinitionRemoved, revive

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

containsItemDefinition, findContainerDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findNamedItemDefinition, findPropertyDefinition, findReferenceDefinition, findReferenceDefinition, getDefaultNamespace, getDefinitions, getDiagrams, getExtensionForType, getIgnoredNamespaces, hasSubstitutions, isContainerMarker, isEmpty, isListMarker, isObjectMarker, isReferenceMarker, isShared, isXsdAnyMarker, itemOrSubstitution, merge, substitution, trimTo

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

accept, accept, debugDump, debugDump, debugDump, debugDumpLazily, debugDumpLazily, getAnnotation, getDeprecatedSince, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getPrismContext, getProcessing, getSchemaMigrations, getSchemaRegistry, getTypeClass, getTypeClassIfKnown, getTypeName, isAbstract, isDeprecated, isElaborate, isEmphasized, isExperimental, isIgnored, isRuntimeSchema, setAnnotation

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

checkImmutable, checkMutable, freeze, isImmutable

Methods inherited from interface com.evolveum.midpoint.schema.processor.ObjectClassComplexTypeDefinition

clone, deepClone, hasIndexOnlyAttributes, isIdentifier, toMutable

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

isAssignableFrom

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

canRepresent, getCompileTimeClass, getInstantiationOrder, getStaticSubTypes, getSuperType

Method Detail

delegate

ObjectClassComplexTypeDefinition delegate()

Specified by:

delegate in interface ComplexTypeDefinitionDelegator

Specified by:

delegate in interface DefinitionDelegator

Specified by:

delegate in interface TypeDefinitionDelegator

getAttributeDefinitions

@NotNull
default @NotNull Collection<? extends ResourceAttributeDefinition<?>> getAttributeDefinitions()

Description copied from interface: ObjectClassComplexTypeDefinition

Returns all attribute definitions as an unmodifiable collection. Should be the same content as returned by getDefinitions().

Specified by:

getAttributeDefinitions in interface ObjectClassComplexTypeDefinition

findAttributeDefinition

@Nullable
default <X> @Nullable ResourceAttributeDefinition<X> findAttributeDefinition(QName name)

Description copied from interface: ObjectClassComplexTypeDefinition

Finds a attribute definition by looking at the property name.

Returns null if nothing is found.

Specified by:

findAttributeDefinition in interface ObjectClassComplexTypeDefinition

Parameters:

name - property definition name

Returns:

found property definition or null

findAttributeDefinition

@Nullable
default <X> @Nullable ResourceAttributeDefinition<X> findAttributeDefinition(QName name,
                                                                             boolean caseInsensitive)

Description copied from interface: ObjectClassComplexTypeDefinition

Finds a attribute definition by looking at the property name; not considering the case.

Returns null if nothing is found.

Specified by:

findAttributeDefinition in interface ObjectClassComplexTypeDefinition

Parameters:

name - property definition name

Returns:

found property definition or null

findAttributeDefinition

default <X> ResourceAttributeDefinition<X> findAttributeDefinition(String name)

Specified by:

findAttributeDefinition in interface ObjectClassComplexTypeDefinition

getPrimaryIdentifiers

@NotNull
default @NotNull Collection<? extends ResourceAttributeDefinition<?>> getPrimaryIdentifiers()

Description copied from interface: ObjectClassComplexTypeDefinition

Returns the definition of primary identifier attributes of a resource object. May return empty set if there are no identifier attributes. Must not return null. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.

Specified by:

getPrimaryIdentifiers in interface ObjectClassComplexTypeDefinition

Returns:

definition of identifier attributes

isPrimaryIdentifier

default boolean isPrimaryIdentifier(QName attrName)

Description copied from interface: ObjectClassComplexTypeDefinition

Returns true if the attribute with a given name is among primary identifiers. Matching is done using namespace-approximate method (testing only local part if no namespace is provided), so beware of incidental matching (e.g. ri:uid vs icfs:uid).

Specified by:

isPrimaryIdentifier in interface ObjectClassComplexTypeDefinition

getSecondaryIdentifiers

@NotNull
default @NotNull Collection<? extends ResourceAttributeDefinition<?>> getSecondaryIdentifiers()

Description copied from interface: ObjectClassComplexTypeDefinition

Returns the definition of secondary identifier attributes of a resource object. May return empty set if there are no secondary identifier attributes. Must not return null. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.

Specified by:

getSecondaryIdentifiers in interface ObjectClassComplexTypeDefinition

Returns:

definition of secondary identifier attributes

isSecondaryIdentifier

default boolean isSecondaryIdentifier(QName attrName)

Description copied from interface: ObjectClassComplexTypeDefinition

Returns true if the attribute with a given name is among secondary identifiers. Matching is done using namespace-approximate method (testing only local part if no namespace is provided), so beware of incidental matching (e.g. ri:uid vs icfs:uid).

Specified by:

isSecondaryIdentifier in interface ObjectClassComplexTypeDefinition

getDescriptionAttribute

default <X> ResourceAttributeDefinition<X> getDescriptionAttribute()

Description copied from interface: ObjectClassComplexTypeDefinition

Returns the definition of description attribute of a resource object. Returns null if there is no description attribute. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.

Specified by:

getDescriptionAttribute in interface ObjectClassComplexTypeDefinition

getNamingAttribute

default <X> ResourceAttributeDefinition<X> getNamingAttribute()

Description copied from interface: ObjectClassComplexTypeDefinition

TODO

Specified by:

getNamingAttribute in interface ObjectClassComplexTypeDefinition

getDisplayNameAttribute

default <X> ResourceAttributeDefinition<X> getDisplayNameAttribute()

Description copied from interface: ObjectClassComplexTypeDefinition

Returns the definition of display name attribute. Display name attribute specifies which resource attribute should be used as title when displaying objects of a specific resource object class. It must point to an attribute of String type. If not present, primary identifier should be used instead (but this method does not handle this default behavior). Returns null if there is no display name attribute. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.

Specified by:

getDisplayNameAttribute in interface ObjectClassComplexTypeDefinition

getAllIdentifiers

default Collection<? extends ResourceAttributeDefinition<?>> getAllIdentifiers()

Description copied from interface: ObjectClassComplexTypeDefinition

Returns both primary and secondary identifiers.

Specified by:

getAllIdentifiers in interface ObjectClassComplexTypeDefinition

getNativeObjectClass

default String getNativeObjectClass()

Description copied from interface: ObjectClassComplexTypeDefinition

Returns the native object class string for the resource object. Native object class is the name of the Resource Object Definition (Object Class) as it is seen by the resource itself. The name of the Resource Object Definition may be constrained by XSD or other syntax and therefore may be "mangled" to conform to such syntax. The native object class value will contain unmangled name (if available). Returns null if there is no native object class. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.

Specified by:

getNativeObjectClass in interface ObjectClassComplexTypeDefinition

Returns:

native object class

isAuxiliary

default boolean isAuxiliary()

Description copied from interface: ObjectClassComplexTypeDefinition

TODO

Specified by:

isAuxiliary in interface ObjectClassComplexTypeDefinition

Returns:

getKind

default ShadowKindType getKind()

Description copied from interface: ObjectClassComplexTypeDefinition

TODO: THIS SHOULD NOT BE HERE

Specified by:

getKind in interface ObjectClassComplexTypeDefinition

Returns:

isDefaultInAKind

default boolean isDefaultInAKind()

Description copied from interface: ObjectClassComplexTypeDefinition

Indicates whether definition is should be used as default definition in ist kind. E.g. if used in an "account" kind it indicates default account definition. If true value is returned then the definition should be used as a default definition for the kind. This is a way how a resource connector may suggest applicable object classes (resource object definitions) for individual shadow kinds (e.g. accounts).

Specified by:

isDefaultInAKind in interface ObjectClassComplexTypeDefinition

Returns:

true if the definition should be used as account type.

getIntent

default String getIntent()

Description copied from interface: ObjectClassComplexTypeDefinition

TODO: THIS SHOULD NOT BE HERE

Specified by:

getIntent in interface ObjectClassComplexTypeDefinition

Returns:

toResourceAttributeContainerDefinition

default ResourceAttributeContainerDefinition toResourceAttributeContainerDefinition()

Specified by:

toResourceAttributeContainerDefinition in interface ObjectClassComplexTypeDefinition

toResourceAttributeContainerDefinition

default ResourceAttributeContainerDefinition toResourceAttributeContainerDefinition(QName elementName)

Specified by:

toResourceAttributeContainerDefinition in interface ObjectClassComplexTypeDefinition

createShadowSearchQuery

default ObjectQuery createShadowSearchQuery(String resourceOid)
                                     throws SchemaException

Specified by:

createShadowSearchQuery in interface ObjectClassComplexTypeDefinition

Throws:

SchemaException

instantiate

default ResourceAttributeContainer instantiate(QName elementName)

Specified by:

instantiate in interface ObjectClassComplexTypeDefinition

matches

@Deprecated
default boolean matches(ShadowType shadow)

Deprecated.

Description copied from interface: ObjectClassComplexTypeDefinition

Do not use. Unclear semantics. For synchronization tasks use com.evolveum.midpoint.model.impl.sync.SynchronizationObjectsFilter class instead.

Specified by:

matches in interface ObjectClassComplexTypeDefinition