Package com.evolveum.midpoint.prism

Interface PrismPropertyDefinition<T>

All Superinterfaces:

Cloneable, DebugDumpable, Definition, Freezable, ItemDefinition<PrismProperty<T>>, PrismContextSensitive, PrismItemAccessDefinition, Revivable, Serializable, SmartVisitable<Definition>, Visitable<Definition>

All Known Subinterfaces:

AttributeDefinitionDelegator<T>, LayerRefinedAttributeDefinition<T>, MutablePrismPropertyDefinition<T>, MutableResourceAttributeDefinition<T>, PropertyDefinitionDelegator<T>, RefinedAttributeDefinition<T>, RefinedAttributeDefinitionDelegator<T>, ResourceAttributeDefinition<T>

All Known Implementing Classes:

LayerRefinedAttributeDefinitionImpl, com.evolveum.midpoint.prism.impl.PrismPropertyDefinitionImpl, RefinedAttributeDefinitionImpl, ResourceAttributeDefinitionImpl

public interface PrismPropertyDefinition<T>
extends ItemDefinition<PrismProperty<T>>

Author:

mederly

Nested Class Summary

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

PrismItemAccessDefinition.Mutable

Field Summary

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

INDENT_STRING

Method Summary

Modifier and Type	Method	Description
@NotNull PrismPropertyDefinition<T>	clone()
PropertyDelta<T>	createEmptyDelta(ItemPath path)
T	defaultValue()
Collection<? extends DisplayableValue<T>>	getAllowedValues()
QName	getMatchingRuleQName()
Class<T>	getTypeClass()	Returns a compile-time class that is used to represent items.
QName	getValueType()	Deprecated.
@NotNull PrismProperty<T>	instantiate()	Create an item instance.
@NotNull PrismProperty<T>	instantiate(QName name)	Create an item instance.
default boolean	isAnyType()
Boolean	isIndexed()
MutablePrismPropertyDefinition<T>	toMutable()

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

debugDump, debugDump, debugDumpLazily, debugDumpLazily

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

debugDump, getAnnotation, getDeprecatedSince, getDiagrams, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getMutabilityFlag, getPlannedRemoval, getProcessing, getSchemaMigrations, getSchemaRegistry, 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.prism.ItemDefinition

adoptElementDefinitionFrom, canBeDefinitionOf, canBeDefinitionOf, debugDumpShortToString, deepClone, deepClone, findItemDefinition, getItemName, getMaxOccurs, getMinOccurs, getNamespace, getSubstitutionHead, getValueEnumerationRef, isDynamic, isHeterogeneousListItem, isIndexOnly, isInherited, isMandatory, isMultiValue, isOperational, isOptional, isSingleValue, isValidFor, isValidFor, revive, structuredType

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

getPrismContext

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

canAdd, canModify, canRead

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

accept

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

accept

Method Detail

getAllowedValues

Collection<? extends DisplayableValue<T>> getAllowedValues()

defaultValue

T defaultValue()

getValueType

@Deprecated
QName getValueType()

Deprecated.

Returns QName of the property value type.

The returned type is either XSD simple type or complex type. It may not be defined in the same schema (especially if it is standard XSD simple type).

Returns:

QName of the property value type NOTE: This is very strange property. Isn't it the same as typeName(). It is even not used in midPoint. Marking as deprecated.

isIndexed

Boolean isIndexed()

isAnyType

default boolean isAnyType()

getMatchingRuleQName

QName getMatchingRuleQName()

createEmptyDelta

PropertyDelta<T> createEmptyDelta(ItemPath path)

Specified by:

createEmptyDelta in interface ItemDefinition<T>

instantiate

@NotNull
@NotNull PrismProperty<T> instantiate()

Description copied from interface: ItemDefinition

Create an item instance. Definition name or default name will used as an element name for the instance. The instance will otherwise be empty.

Specified by:

instantiate in interface ItemDefinition<T>

Returns:

created item instance

instantiate

@NotNull
@NotNull PrismProperty<T> instantiate(QName name)

Description copied from interface: ItemDefinition

Create an item instance. Definition name will use provided name. for the instance. The instance will otherwise be empty.

Specified by:

instantiate in interface ItemDefinition<T>

Returns:

created item instance

clone

@NotNull
@NotNull PrismPropertyDefinition<T> clone()

Specified by:

clone in interface Definition

Specified by:

clone in interface ItemDefinition<T>

getTypeClass

Class<T> getTypeClass()

Description copied from interface: Definition

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

Specified by:

getTypeClass in interface Definition

toMutable

MutablePrismPropertyDefinition<T> toMutable()

Specified by:

toMutable in interface Definition

Specified by:

toMutable in interface ItemDefinition<T>