Class LayerRefinedAttributeDefinitionImpl<T>
- java.lang.Object
-
- com.evolveum.midpoint.prism.AbstractFreezable
-
- com.evolveum.midpoint.common.refinery.LayerRefinedAttributeDefinitionImpl<T>
-
- All Implemented Interfaces:
LayerRefinedAttributeDefinition<T>,RefinedAttributeDefinition<T>,Definition,Freezable,ItemDefinition<PrismProperty<T>>,PrismContextSensitive,PrismItemAccessDefinition,PrismPropertyDefinition<T>,Revivable,SmartVisitable<Definition>,Visitable<Definition>,ResourceAttributeDefinition<T>,DebugDumpable,Serializable,Cloneable
public final class LayerRefinedAttributeDefinitionImpl<T> extends AbstractFreezable implements LayerRefinedAttributeDefinition<T>
- Author:
- semancik
- See Also:
- Serialized Form
-
-
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaccept(Visitor<Definition> visitor)booleanaccept(Visitor<Definition> visitor, SmartVisitation<Definition> visitation)voidadoptElementDefinitionFrom(ItemDefinition otherDef)booleancanAdd()Returns true if this item can be added: it can be part of an object that is created.booleancanAdd(LayerType layer)booleancanBeDefinitionOf(PrismProperty<T> item)booleancanBeDefinitionOf(PrismValue pvalue)booleancanModify()Returns true if this item can be modified (updated).booleancanModify(LayerType layer)booleancanRead()Returns true if this item can be read (displayed).booleancanRead(LayerType layer)@NotNull RefinedAttributeDefinition<T>clone()PropertyDelta<T>createEmptyDelta(ItemPath path)StringdebugDump(int indent)StringdebugDump(int indent, LayerType layer)voiddebugDumpShortToString(StringBuilder sb)Used in debugDumping items.ItemDefinition<PrismProperty<T>>deepClone(boolean ultraDeep, Consumer<ItemDefinition> postCloneAction)RefinedAttributeDefinition<T>deepClone(Map<QName,ComplexTypeDefinition> ctdMap, Map<QName,ComplexTypeDefinition> onThisPath, Consumer<ItemDefinition> postCloneAction)TdefaultValue()booleanequals(Object obj)<DT extends ItemDefinition>
DTfindItemDefinition(@NotNull ItemPath path, @NotNull Class<DT> clazz)Collection<? extends DisplayableValue<T>>getAllowedValues()<A> AgetAnnotation(QName qname)Returns generic definition annotation.ResourceAttributeDefinition<T>getAttributeDefinition()StringgetDebugDumpClassName()Return a human readable name of this class suitable for logs.StringgetDeprecatedSince()StringgetDescription()List<ItemDiagramSpecification>getDiagrams()StringgetDisplayName()Returns display name.IntegergetDisplayOrder()Specifies an order in which the item should be displayed relative to other items at the same level.StringgetDocumentation()StringgetDocumentationPreview()Returns only a first sentence of documentation.AttributeFetchStrategyTypegetFetchStrategy()StringgetFrameworkAttributeName()StringgetHelp()Returns help string.List<MappingType>getInboundMappingTypes()List<String>getIntolerantValuePattern()@NotNull ItemNamegetItemName()LayerTypegetLayer()PropertyLimitationsgetLimitations()PropertyLimitationsgetLimitations(LayerType layer)QNamegetMatchingRuleQName()intgetMaxOccurs()intgetMaxOccurs(LayerType layer)intgetMinOccurs()intgetMinOccurs(LayerType layer)IntegergetModificationPriority()StringgetNamespace()StringgetNativeAttributeName()MappingTypegetOutboundMappingType()BooleangetOverrideCanAdd()BooleangetOverrideCanModify()BooleangetOverrideCanRead()StringgetPlannedRemoval()Version of data model in which the item is likely to be removed.PrismContextgetPrismContext()ItemProcessinggetProcessing()ItemProcessinggetProcessing(LayerType layer)BooleangetReadReplaceMode()BooleangetReturnedByDefault()List<SchemaMigration>getSchemaMigrations()AttributeStorageStrategyTypegetStorageStrategy()QNamegetSubstitutionHead()Returns the name of an element this one can be substituted for (e.g.List<String>getTolerantValuePattern()ClassgetTypeClass()Returns a compile-time class that is used to represent items.ClassgetTypeClassIfKnown()@NotNull QNamegetTypeName()Returns a name of the type for this definition.PrismReferenceValuegetValueEnumerationRef()QNamegetValueType()Returns QName of the property value type.inthashCode()booleanhasOutboundMapping()@NotNull ResourceAttribute<T>instantiate()Create an item instance.@NotNull ResourceAttribute<T>instantiate(QName name)Create an item instance.booleanisAbstract()booleanisDeprecated()booleanisDisplayNameAttribute()booleanisDynamic()Returns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML.booleanisElaborate()Elaborate items are complicated data structure that may deviate from normal principles of the system.booleanisEmphasized()True for definitions that are more important than others and that should be emphasized during presentation.booleanisExclusiveStrong()booleanisExperimental()Experimental functionality is not stable and it may be changed in any future release without any warning.booleanisHeterogeneousListItem()Can be used in heterogeneous lists as a list item.booleanisIgnored()Item definition that has this flag set should be ignored by any processing.booleanisIgnored(LayerType layer)BooleanisIndexed()booleanisIndexOnly()EXPERIMENTAL.booleanisInherited()Whether an item is inherited from a supertype.booleanisMandatory()booleanisMandatory(LayerType layer)booleanisMultiValue()booleanisMultiValue(LayerType layer)booleanisOperational()booleanisOptional()booleanisOptional(LayerType layer)booleanisPrimaryIdentifier(ObjectClassComplexTypeDefinition objectDefinition)booleanisPrimaryIdentifier(ResourceAttributeContainerDefinition objectDefinition)booleanisReturnedByDefault()booleanisRuntimeSchema()This means that this particular definition (of an item or of a type) is part of the runtime schema, e.g.booleanisSecondaryIdentifier(ObjectClassComplexTypeDefinition objectDefinition)BooleanisSecondaryIdentifierOverride()booleanisSingleValue()booleanisSingleValue(LayerType layer)booleanisTolerant()booleanisValidFor(@NotNull QName elementQName, @NotNull Class<? extends ItemDefinition> clazz, boolean caseInsensitive)booleanisValidFor(QName elementQName, Class<? extends ItemDefinition> clazz)booleanisVolatilityTrigger()voidrevive(PrismContext prismContext)<A> voidsetAnnotation(QName qname, A value)voidsetOverrideCanAdd(Boolean overrideCanAdd)voidsetOverrideCanModify(Boolean overrideCanModify)voidsetOverrideCanRead(Boolean overrideCanRead)Optional<ComplexTypeDefinition>structuredType()Returns complex type definition of item, if underlying value is possible structured.MutableResourceAttributeDefinition<T>toMutable()StringtoString()-
Methods inherited from class com.evolveum.midpoint.prism.AbstractFreezable
freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable, performFreeze
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable
debugDump, debugDumpLazily, debugDumpLazily
-
Methods inherited from interface com.evolveum.midpoint.prism.Definition
debugDump, getMutabilityFlag, getSchemaRegistry
-
Methods inherited from interface com.evolveum.midpoint.prism.Freezable
checkImmutable, checkMutable, freeze, isImmutable
-
Methods inherited from interface com.evolveum.midpoint.prism.PrismPropertyDefinition
isAnyType
-
-
-
-
Method Detail
-
getLayer
public LayerType getLayer()
- Specified by:
getLayerin interfaceLayerRefinedAttributeDefinition<T>
-
getOverrideCanRead
public Boolean getOverrideCanRead()
- Specified by:
getOverrideCanReadin interfaceLayerRefinedAttributeDefinition<T>
-
setOverrideCanRead
public void setOverrideCanRead(Boolean overrideCanRead)
-
getOverrideCanAdd
public Boolean getOverrideCanAdd()
- Specified by:
getOverrideCanAddin interfaceLayerRefinedAttributeDefinition<T>
-
setOverrideCanAdd
public void setOverrideCanAdd(Boolean overrideCanAdd)
-
getOverrideCanModify
public Boolean getOverrideCanModify()
- Specified by:
getOverrideCanModifyin interfaceLayerRefinedAttributeDefinition<T>
-
setOverrideCanModify
public void setOverrideCanModify(Boolean overrideCanModify)
-
canAdd
public boolean canAdd()
Description copied from interface:PrismItemAccessDefinitionReturns true if this item can be added: it can be part of an object that is created. In case of containers this means that the container itself should be displayed in creation forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one createable item. This does NOT mean that also all the container items can be created. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.- Specified by:
canAddin interfacePrismItemAccessDefinition
-
getLimitations
public PropertyLimitations getLimitations()
- Specified by:
getLimitationsin interfaceLayerRefinedAttributeDefinition<T>
-
accept
public void accept(Visitor<Definition> visitor)
-
accept
public boolean accept(Visitor<Definition> visitor, SmartVisitation<Definition> visitation)
- Specified by:
acceptin interfaceSmartVisitable<T>- Returns:
- false if we already was here
-
clone
@NotNull public @NotNull RefinedAttributeDefinition<T> clone()
- Specified by:
clonein interfaceDefinition- Specified by:
clonein interfaceItemDefinition<T>- Specified by:
clonein interfacePrismPropertyDefinition<T>- Specified by:
clonein interfaceRefinedAttributeDefinition<T>- Specified by:
clonein interfaceResourceAttributeDefinition<T>- Overrides:
clonein classObject
-
debugDump
public String debugDump(int indent, LayerType layer)
- Specified by:
debugDumpin interfaceRefinedAttributeDefinition<T>
-
canRead
public boolean canRead()
Description copied from interface:PrismItemAccessDefinitionReturns true if this item can be read (displayed). In case of containers this flag is, strictly speaking, not applicable. Container is an empty shell. What matters is access to individual sub-item. However, for containers this value has a "hint" meaning. It means that the container itself contains something that is readable. Which can be used as a hint by the presentation to display container label or block. This usually happens if the container contains at least one readable item. This does NOT mean that also all the container items can be displayed. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.Note: It was considered to use a different meaning for this flag - a meaning that would allow canRead()=false containers to have readable items. However, this was found not to be very useful. Therefore the "something readable inside" meaning was confirmed instead.
- Specified by:
canReadin interfacePrismItemAccessDefinition
-
isIgnored
public boolean isIgnored(LayerType layer)
- Specified by:
isIgnoredin interfaceRefinedAttributeDefinition<T>
-
getProcessing
public ItemProcessing getProcessing()
- Specified by:
getProcessingin interfaceDefinition
-
getProcessing
public ItemProcessing getProcessing(LayerType layer)
- Specified by:
getProcessingin interfaceRefinedAttributeDefinition<T>
-
getSchemaMigrations
public List<SchemaMigration> getSchemaMigrations()
- Specified by:
getSchemaMigrationsin interfaceDefinition
-
getDiagrams
public List<ItemDiagramSpecification> getDiagrams()
- Specified by:
getDiagramsin interfaceDefinition
-
canModify
public boolean canModify()
Description copied from interface:PrismItemAccessDefinitionReturns true if this item can be modified (updated). In case of containers this means that the container itself should be displayed in modification forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one modifiable item. This does NOT mean that also all the container items can be modified. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.- Specified by:
canModifyin interfacePrismItemAccessDefinition
-
debugDump
public String debugDump(int indent)
- Specified by:
debugDumpin interfaceDebugDumpable
-
getDebugDumpClassName
public String getDebugDumpClassName()
Return a human readable name of this class suitable for logs.
-
getFrameworkAttributeName
public String getFrameworkAttributeName()
- Specified by:
getFrameworkAttributeNamein interfaceResourceAttributeDefinition<T>
-
isInherited
public boolean isInherited()
Description copied from interface:ItemDefinitionWhether an item is inherited from a supertype.- Specified by:
isInheritedin interfaceItemDefinition<T>
-
getModificationPriority
public Integer getModificationPriority()
- Specified by:
getModificationPriorityin interfaceRefinedAttributeDefinition<T>
-
getReadReplaceMode
public Boolean getReadReplaceMode()
- Specified by:
getReadReplaceModein interfaceRefinedAttributeDefinition<T>
-
findItemDefinition
public <DT extends ItemDefinition> DT findItemDefinition(@NotNull @NotNull ItemPath path, @NotNull @NotNull Class<DT> clazz)
- Specified by:
findItemDefinitionin interfaceItemDefinition<T>
-
isDisplayNameAttribute
public boolean isDisplayNameAttribute()
- Specified by:
isDisplayNameAttributein interfaceRefinedAttributeDefinition<T>
-
deepClone
public ItemDefinition<PrismProperty<T>> deepClone(boolean ultraDeep, Consumer<ItemDefinition> postCloneAction)
- Specified by:
deepClonein interfaceItemDefinition<T>
-
revive
public void revive(PrismContext prismContext)
- Specified by:
revivein interfaceItemDefinition<T>- Specified by:
revivein interfaceRevivable
-
getDisplayOrder
public Integer getDisplayOrder()
Description copied from interface:DefinitionSpecifies 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:
getDisplayOrderin interfaceDefinition
-
getHelp
public String getHelp()
Description copied from interface:DefinitionReturns 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.- Specified by:
getHelpin interfaceDefinition- Returns:
- help string or catalog key
-
getDocumentation
public String getDocumentation()
- Specified by:
getDocumentationin interfaceDefinition
-
getDocumentationPreview
public String getDocumentationPreview()
Description copied from interface:DefinitionReturns only a first sentence of documentation.- Specified by:
getDocumentationPreviewin interfaceDefinition
-
isRuntimeSchema
public boolean isRuntimeSchema()
Description copied from interface:DefinitionThis 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.- Specified by:
isRuntimeSchemain interfaceDefinition
-
getPrismContext
public PrismContext getPrismContext()
- Specified by:
getPrismContextin interfacePrismContextSensitive
-
getTypeClassIfKnown
public Class getTypeClassIfKnown()
- Specified by:
getTypeClassIfKnownin interfaceDefinition
-
getTypeClass
public Class getTypeClass()
Description copied from interface:DefinitionReturns 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:
getTypeClassin interfaceDefinition- Specified by:
getTypeClassin interfacePrismPropertyDefinition<T>
-
toMutable
public MutableResourceAttributeDefinition<T> toMutable()
- Specified by:
toMutablein interfaceDefinition- Specified by:
toMutablein interfaceItemDefinition<T>- Specified by:
toMutablein interfacePrismPropertyDefinition<T>- Specified by:
toMutablein interfaceResourceAttributeDefinition<T>
-
getDescription
public String getDescription()
- Specified by:
getDescriptionin interfaceRefinedAttributeDefinition<T>
-
getValueEnumerationRef
public PrismReferenceValue getValueEnumerationRef()
- Specified by:
getValueEnumerationRefin interfaceItemDefinition<T>
-
getAttributeDefinition
public ResourceAttributeDefinition<T> getAttributeDefinition()
- Specified by:
getAttributeDefinitionin interfaceRefinedAttributeDefinition<T>
-
isValidFor
public boolean isValidFor(QName elementQName, Class<? extends ItemDefinition> clazz)
- Specified by:
isValidForin interfaceItemDefinition<T>
-
getOutboundMappingType
public MappingType getOutboundMappingType()
- Specified by:
getOutboundMappingTypein interfaceRefinedAttributeDefinition<T>
-
hasOutboundMapping
public boolean hasOutboundMapping()
- Specified by:
hasOutboundMappingin interfaceRefinedAttributeDefinition<T>
-
isValidFor
public boolean isValidFor(@NotNull @NotNull QName elementQName, @NotNull @NotNull Class<? extends ItemDefinition> clazz, boolean caseInsensitive)- Specified by:
isValidForin interfaceItemDefinition<T>
-
getInboundMappingTypes
public List<MappingType> getInboundMappingTypes()
- Specified by:
getInboundMappingTypesin interfaceRefinedAttributeDefinition<T>
-
getMaxOccurs
public int getMaxOccurs(LayerType layer)
- Specified by:
getMaxOccursin interfaceRefinedAttributeDefinition<T>
-
getMinOccurs
public int getMinOccurs(LayerType layer)
- Specified by:
getMinOccursin interfaceRefinedAttributeDefinition<T>
-
adoptElementDefinitionFrom
public void adoptElementDefinitionFrom(ItemDefinition otherDef)
- Specified by:
adoptElementDefinitionFromin interfaceItemDefinition<T>
-
isOptional
public boolean isOptional(LayerType layer)
- Specified by:
isOptionalin interfaceRefinedAttributeDefinition<T>
-
isEmphasized
public boolean isEmphasized()
Description copied from interface:DefinitionTrue 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.- Specified by:
isEmphasizedin interfaceDefinition
-
isMandatory
public boolean isMandatory(LayerType layer)
- Specified by:
isMandatoryin interfaceRefinedAttributeDefinition<T>
-
isMultiValue
public boolean isMultiValue(LayerType layer)
- Specified by:
isMultiValuein interfaceRefinedAttributeDefinition<T>
-
isSingleValue
public boolean isSingleValue(LayerType layer)
- Specified by:
isSingleValuein interfaceRefinedAttributeDefinition<T>
-
isExclusiveStrong
public boolean isExclusiveStrong()
- Specified by:
isExclusiveStrongin interfaceRefinedAttributeDefinition<T>
-
getLimitations
public PropertyLimitations getLimitations(LayerType layer)
- Specified by:
getLimitationsin interfaceRefinedAttributeDefinition<T>
-
getFetchStrategy
public AttributeFetchStrategyType getFetchStrategy()
- Specified by:
getFetchStrategyin interfaceRefinedAttributeDefinition<T>
-
getStorageStrategy
public AttributeStorageStrategyType getStorageStrategy()
- Specified by:
getStorageStrategyin interfaceRefinedAttributeDefinition<T>
-
getTolerantValuePattern
public List<String> getTolerantValuePattern()
- Specified by:
getTolerantValuePatternin interfaceRefinedAttributeDefinition<T>
-
getIntolerantValuePattern
public List<String> getIntolerantValuePattern()
- Specified by:
getIntolerantValuePatternin interfaceRefinedAttributeDefinition<T>
-
isVolatilityTrigger
public boolean isVolatilityTrigger()
- Specified by:
isVolatilityTriggerin interfaceRefinedAttributeDefinition<T>
-
getDisplayName
public String getDisplayName()
Description copied from interface:DefinitionReturns 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:
getDisplayNamein interfaceDefinition- Returns:
- display name string or catalog key
-
instantiate
@NotNull public @NotNull ResourceAttribute<T> instantiate()
Description copied from interface:ItemDefinitionCreate 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:
instantiatein interfaceItemDefinition<T>- Specified by:
instantiatein interfacePrismPropertyDefinition<T>- Specified by:
instantiatein interfaceResourceAttributeDefinition<T>- Returns:
- created item instance
-
instantiate
@NotNull public @NotNull ResourceAttribute<T> instantiate(QName name)
Description copied from interface:ItemDefinitionCreate an item instance. Definition name will use provided name. for the instance. The instance will otherwise be empty.- Specified by:
instantiatein interfaceItemDefinition<T>- Specified by:
instantiatein interfacePrismPropertyDefinition<T>- Specified by:
instantiatein interfaceResourceAttributeDefinition<T>- Returns:
- created item instance
-
getReturnedByDefault
public Boolean getReturnedByDefault()
- Specified by:
getReturnedByDefaultin interfaceResourceAttributeDefinition<T>
-
isReturnedByDefault
public boolean isReturnedByDefault()
- Specified by:
isReturnedByDefaultin interfaceResourceAttributeDefinition<T>
-
isPrimaryIdentifier
public boolean isPrimaryIdentifier(ResourceAttributeContainerDefinition objectDefinition)
- Specified by:
isPrimaryIdentifierin interfaceResourceAttributeDefinition<T>
-
getItemName
@NotNull public @NotNull ItemName getItemName()
- Specified by:
getItemNamein interfaceItemDefinition<T>
-
getNamespace
public String getNamespace()
- Specified by:
getNamespacein interfaceItemDefinition<T>
-
getMinOccurs
public int getMinOccurs()
- Specified by:
getMinOccursin interfaceItemDefinition<T>
-
getAllowedValues
public Collection<? extends DisplayableValue<T>> getAllowedValues()
- Specified by:
getAllowedValuesin interfacePrismPropertyDefinition<T>
-
getMaxOccurs
public int getMaxOccurs()
- Specified by:
getMaxOccursin interfaceItemDefinition<T>
-
isPrimaryIdentifier
public boolean isPrimaryIdentifier(ObjectClassComplexTypeDefinition objectDefinition)
- Specified by:
isPrimaryIdentifierin interfaceResourceAttributeDefinition<T>
-
defaultValue
public T defaultValue()
- Specified by:
defaultValuein interfacePrismPropertyDefinition<T>
-
isTolerant
public boolean isTolerant()
- Specified by:
isTolerantin interfaceRefinedAttributeDefinition<T>
-
isSingleValue
public boolean isSingleValue()
- Specified by:
isSingleValuein interfaceItemDefinition<T>
-
getValueType
public QName getValueType()
Description copied from interface:PrismPropertyDefinitionReturns 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).
- Specified by:
getValueTypein interfacePrismPropertyDefinition<T>- 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.
-
isSecondaryIdentifierOverride
public Boolean isSecondaryIdentifierOverride()
- Specified by:
isSecondaryIdentifierOverridein interfaceRefinedAttributeDefinition<T>
-
isMultiValue
public boolean isMultiValue()
- Specified by:
isMultiValuein interfaceItemDefinition<T>
-
getTypeName
@NotNull public @NotNull QName getTypeName()
Description copied from interface:DefinitionReturns 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:
getTypeNamein interfaceDefinition- Returns:
- the type name
-
isIndexed
public Boolean isIndexed()
- Specified by:
isIndexedin interfacePrismPropertyDefinition<T>
-
canAdd
public boolean canAdd(LayerType layer)
- Specified by:
canAddin interfaceRefinedAttributeDefinition<T>
-
isMandatory
public boolean isMandatory()
- Specified by:
isMandatoryin interfaceItemDefinition<T>
-
isIgnored
public boolean isIgnored()
Description copied from interface:DefinitionItem 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.- Specified by:
isIgnoredin interfaceDefinition
-
isSecondaryIdentifier
public boolean isSecondaryIdentifier(ObjectClassComplexTypeDefinition objectDefinition)
- Specified by:
isSecondaryIdentifierin interfaceResourceAttributeDefinition<T>
-
getMatchingRuleQName
public QName getMatchingRuleQName()
- Specified by:
getMatchingRuleQNamein interfacePrismPropertyDefinition<T>
-
isAbstract
public boolean isAbstract()
- Specified by:
isAbstractin interfaceDefinition
-
isOptional
public boolean isOptional()
- Specified by:
isOptionalin interfaceItemDefinition<T>
-
canRead
public boolean canRead(LayerType layer)
- Specified by:
canReadin interfaceRefinedAttributeDefinition<T>
-
isDeprecated
public boolean isDeprecated()
- Specified by:
isDeprecatedin interfaceDefinition
-
getDeprecatedSince
public String getDeprecatedSince()
- Specified by:
getDeprecatedSincein interfaceDefinition
-
isExperimental
public boolean isExperimental()
Description copied from interface:DefinitionExperimental functionality is not stable and it may be changed in any future release without any warning. Use at your own risk.- Specified by:
isExperimentalin interfaceDefinition
-
getPlannedRemoval
public String getPlannedRemoval()
Description copied from interface:DefinitionVersion 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.- Specified by:
getPlannedRemovalin interfaceDefinition
-
isElaborate
public boolean isElaborate()
Description copied from interface:DefinitionElaborate 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.- Specified by:
isElaboratein interfaceDefinition
-
isOperational
public boolean isOperational()
- Specified by:
isOperationalin interfaceItemDefinition<T>
-
isIndexOnly
public boolean isIndexOnly()
Description copied from interface:ItemDefinitionEXPERIMENTAL. If true, this item is not stored in XML representation in repo. TODO better name- Specified by:
isIndexOnlyin interfaceItemDefinition<T>
-
createEmptyDelta
public PropertyDelta<T> createEmptyDelta(ItemPath path)
- Specified by:
createEmptyDeltain interfaceItemDefinition<T>- Specified by:
createEmptyDeltain interfacePrismPropertyDefinition<T>
-
canModify
public boolean canModify(LayerType layer)
- Specified by:
canModifyin interfaceRefinedAttributeDefinition<T>
-
isDynamic
public boolean isDynamic()
Description copied from interface:ItemDefinitionReturns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML. This means that the definition needs to be stored alongside the data to have a successful serialization "roundtrip". The definition is not part of any schema and therefore cannot be determined. It may even be different for every instance of the associated item (element name).- Specified by:
isDynamicin interfaceItemDefinition<T>
-
getNativeAttributeName
public String getNativeAttributeName()
- Specified by:
getNativeAttributeNamein interfaceResourceAttributeDefinition<T>
-
deepClone
public RefinedAttributeDefinition<T> deepClone(Map<QName,ComplexTypeDefinition> ctdMap, Map<QName,ComplexTypeDefinition> onThisPath, Consumer<ItemDefinition> postCloneAction)
- Specified by:
deepClonein interfaceItemDefinition<T>- Specified by:
deepClonein interfaceRefinedAttributeDefinition<T>
-
getSubstitutionHead
public QName getSubstitutionHead()
Description copied from interface:ItemDefinitionReturns the name of an element this one can be substituted for (e.g. c:user -> c:object, s:pipeline -> s:expression, etc). EXPERIMENTAL- Specified by:
getSubstitutionHeadin interfaceItemDefinition<T>
-
isHeterogeneousListItem
public boolean isHeterogeneousListItem()
Description copied from interface:ItemDefinitionCan be used in heterogeneous lists as a list item. EXPERIMENTAL.- Specified by:
isHeterogeneousListItemin interfaceItemDefinition<T>
-
debugDumpShortToString
public void debugDumpShortToString(StringBuilder sb)
Description copied from interface:ItemDefinitionUsed in debugDumping items. Does not need to have name in it as item already has it. Does not need to have class as that is just too much info that is almost anytime pretty obvious anyway.- Specified by:
debugDumpShortToStringin interfaceItemDefinition<T>
-
canBeDefinitionOf
public boolean canBeDefinitionOf(PrismProperty<T> item)
- Specified by:
canBeDefinitionOfin interfaceItemDefinition<T>
-
canBeDefinitionOf
public boolean canBeDefinitionOf(PrismValue pvalue)
- Specified by:
canBeDefinitionOfin interfaceItemDefinition<T>
-
getAnnotation
public <A> A getAnnotation(QName qname)
Description copied from interface:DefinitionReturns 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-supported object. E.g. a prims "bean" (JAXB annotated class), prism item, prism value or something like that. EXPERIMENTAL. Hic sunt leones. 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).- Specified by:
getAnnotationin interfaceDefinition
-
setAnnotation
public <A> void setAnnotation(QName qname, A value)
- Specified by:
setAnnotationin interfaceDefinition
-
structuredType
public Optional<ComplexTypeDefinition> structuredType()
Description copied from interface:ItemDefinitionReturns 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:
structuredTypein interfaceItemDefinition<T>- Returns:
-
-