Package com.evolveum.midpoint.schema.processor

Interface ResourceObjectTypeDefinition

All Superinterfaces:

AssociationDefinitionStore, AttributeDefinitionStore, Cloneable, ComplexTypeDefinition, DebugDumpable, Definition, Freezable, IdentifiersDefinitionStore, LayeredDefinition, LocalItemDefinitionStore, PrismContextSensitive, ResourceObjectDefinition, Revivable, Serializable, SmartVisitable<Definition>, TypeDefinition, Visitable<Definition>

All Known Implementing Classes:

ResourceObjectTypeDefinitionImpl

public interface ResourceObjectTypeDefinition
extends ResourceObjectDefinition

Definition of "resource object type". Roughly corresponds to an `objectType` section in `schemaHandling` part of resource definition.

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
default @NotNull ObjectQuery	createShadowSearchQuery(String resourceOid)	Creates a query for obtaining shadows related to this object class or object type.
ResourceObjectTypeDefinition	forLayer(@NotNull LayerType layerType)	Creates a layer-specific version of this definition.
@NotNull ResourceObjectTypeDefinitionType	getDefinitionBean()	Returns the "raw" configuration bean for this object type.
@NotNull String	getIntent()	Intent defining this object type (along with getKind()).
@NotNull ShadowKindType	getKind()	Kind of objects covered by this object type.
boolean	isDefaultForKind()	Is this type explicitly marked as the default object type for given kind? (using default or defaultForKind property).
boolean	isDefaultForObjectClass()	Is this type explicitly marked as the default object type for given object class? (using default or defaultForObjectClass property).
default boolean	matches(@NotNull ShadowKindType kind, @NotNull String intent)	Returns true if this object type matches specified (non-null) kind and intent.
default boolean	matchesKind(@Nullable ShadowKindType kind)	Returns true if the type definition is of specified kind.

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

findAssociationDefinition, findAssociationDefinitionRequired, getAssociationDefinitions, getAssociationDefinitions, getNamesOfAssociations, getNamesOfAssociationsWithInboundExpressions, getNamesOfAssociationsWithOutboundExpressions

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

containsAttributeDefinition, findAttributeDefinition, findAttributeDefinition, findAttributeDefinition, findAttributeDefinitionRequired, findAttributeDefinitionRequired, findAttributeDefinitionStrictlyRequired, findAttributeDefinitionStrictlyRequired, getAttributeDefinitions, getAttributeDefinitions, getNamesOfAttributesWithInboundExpressions, getNamesOfAttributesWithOutboundExpressions, hasIndexOnlyAttributes

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

getDefaultNamespace, getDefinitions, getExtensionForType, getIgnoredNamespaces, getXmlAttributeDefinitions, hasSubstitutions, hasSubstitutions, isContainerMarker, isEmpty, isListMarker, isObjectMarker, isReferenceMarker, isStrictAnyMarker, isXsdAnyMarker, itemOrSubstitution, merge, substitution, toMutable, trimTo

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

debugDump, getAnnotation, getAnnotations, getDeprecatedSince, getDiagrams, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, 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.IdentifiersDefinitionStore

getAllIdentifiers, getPrimaryIdentifiers, getPrimaryIdentifiersNames, getSecondaryIdentifiers, getSecondaryIdentifiersNames, isIdentifier, isPrimaryIdentifier, isSecondaryIdentifier

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

getCurrentLayer

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

containsItemDefinition, findContainerDefinition, findItemDefinition, findItemDefinition, findLocalItemDefinition, findLocalItemDefinition, findPropertyDefinition, findReferenceDefinition

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

getPrismContext

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

clone, createBlankShadow, deepClone, getActivationBidirectionalMappingType, getActivationFetchStrategy, getActivationSchemaHandling, getAuxiliaryDefinitions, getAuxiliaryObjectClassMappings, getBaseContext, getConfiguredAuxiliaryObjectClassNames, getConfiguredCapabilities, getDebugDumpClassName, getDefaultInboundMappingEvaluationPhases, getDescription, getDescriptionAttribute, getDescriptionAttributeName, getDisplayNameAttribute, getDisplayNameAttributeName, getEffectiveCapability, getHumanReadableName, getNamingAttribute, getNamingAttributeName, getObjectClassDefinition, getObjectClassName, getObjectMultiplicity, getPagedSearches, getPasswordDefinition, getPasswordFetchStrategy, getPasswordInbound, getPasswordOutbound, getPrismObjectDefinition, getProjectionPolicy, getProtectedObjectPatterns, getResourceOid, getSearchHierarchyScope, getSecurityPolicyRef, getVolatility, hasAuxiliaryObjectClass, instantiate, isObjectCountingEnabled, isPagedSearchEnabled, matchesObjectClassName, replaceDefinition, replaceDefinition, toResourceAttributeContainerDefinition, toResourceAttributeContainerDefinition

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

revive

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

accept

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

canRepresent, getCompileTimeClass, getInstantiationOrder, getStaticSubTypes, getSuperType, isAssignableFrom

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

accept

Method Detail

createShadowSearchQuery

@NotNull
default @NotNull ObjectQuery createShadowSearchQuery(String resourceOid)
                                              throws SchemaException

Description copied from interface: ResourceObjectDefinition

Creates a query for obtaining shadows related to this object class or object type. The current implementations return either: - a combination of resource OID + object class name, or - a combination of resource OID + kind + intent.

Specified by:

createShadowSearchQuery in interface ResourceObjectDefinition

Throws:

SchemaException

getKind

@NotNull
@NotNull ShadowKindType getKind()

Kind of objects covered by this object type.

getIntent

@NotNull
@NotNull String getIntent()

Intent defining this object type (along with getKind()).

matches

default boolean matches(@NotNull
                        @NotNull ShadowKindType kind,
                        @NotNull
                        @NotNull String intent)

Returns true if this object type matches specified (non-null) kind and intent.

matchesKind

default boolean matchesKind(@Nullable
                            @Nullable ShadowKindType kind)

Returns true if the type definition is of specified kind. Kind of `null` matches all definitions.

isDefaultForKind

boolean isDefaultForKind()

Is this type explicitly marked as the default object type for given kind? (using default or defaultForKind property).

See Also:

ResourceObjectTypeDefinitionType.isDefaultForKind(), ResourceObjectTypeDefinitionType.isDefault()

isDefaultForObjectClass

boolean isDefaultForObjectClass()

Is this type explicitly marked as the default object type for given object class? (using default or defaultForObjectClass property).

See Also:

ResourceObjectTypeDefinitionType.isDefaultForObjectClass(), ResourceObjectTypeDefinitionType.isDefault()

forLayer

ResourceObjectTypeDefinition forLayer(@NotNull
                                      @NotNull LayerType layerType)

Description copied from interface: ResourceObjectDefinition

Creates a layer-specific version of this definition.

Specified by:

forLayer in interface ResourceObjectDefinition

getDefinitionBean

@NotNull
@NotNull ResourceObjectTypeDefinitionType getDefinitionBean()

Returns the "raw" configuration bean for this object type.