LayerRefinedAttributeDefinition (midPoint API Distribution 3.0.1 API)

java.lang.Object
- com.evolveum.midpoint.prism.Definition
- - com.evolveum.midpoint.prism.ItemDefinition
  - - com.evolveum.midpoint.prism.PrismPropertyDefinition
    - - com.evolveum.midpoint.schema.processor.ResourceAttributeDefinition
      - com.evolveum.midpoint.common.refinery.RefinedAttributeDefinition
        
        com.evolveum.midpoint.common.refinery.LayerRefinedAttributeDefinition

All Implemented Interfaces:

com.evolveum.midpoint.prism.Revivable, DebugDumpable, Serializable
```
public class LayerRefinedAttributeDefinition
extends RefinedAttributeDefinition
```
Author:

semancik

See Also:
Serialized Form

Field Summary
- Fields inherited from class com.evolveum.midpoint.common.refinery.RefinedAttributeDefinition
  secondaryIdentifier
- Fields inherited from class com.evolveum.midpoint.prism.ItemDefinition
  name
- Fields inherited from class com.evolveum.midpoint.prism.Definition
  deprecated, displayOrder, documentation, help, ignored, inherited, isAbstract, isRuntimeSchema, prismContext, typeName
- Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable
  INDENT_STRING

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`canAdd()`
`boolean`	`canAdd(LayerType layer)`
`boolean`	`canModify()`
`boolean`	`canModify(LayerType layer)`
`boolean`	`canRead()`
`boolean`	`canRead(LayerType layer)`
`com.evolveum.midpoint.prism.delta.PropertyDelta`	`createEmptyDelta(com.evolveum.midpoint.prism.path.ItemPath path)`
`String`	`debugDump()` Show the content of the object intended for diagnostics by system administrator.
`String`	`debugDump(int indent)`
`boolean`	`equals(Object obj)`
`Object[]`	`getAllowedValues()`
`ResourceAttributeDefinition`	`getAttributeDefinition()`
`protected String`	`getDebugDumpClassName()` Return a human readable name of this class suitable for logs.
`String`	`getDescription()`
`String`	`getDisplayName()`
`Integer`	`getDisplayOrder()`
`String`	`getDocClassName()`
`String`	`getDocumentation()`
`String`	`getDocumentationPreview()`
`AttributeFetchStrategyType`	`getFetchStrategy()`
`String`	`getHelp()`
`List<MappingType>`	`getInboundMappingTypes()`
`List<String>`	`getIntolerantValuePattern()`
`LayerType`	`getLayer()`
`PropertyLimitations`	`getLimitations()`
`PropertyLimitations`	`getLimitations(LayerType layer)`
`QName`	`getMatchingRuleQName()`
`int`	`getMaxOccurs()`
`int`	`getMaxOccurs(LayerType layer)`
`int`	`getMinOccurs()`
`int`	`getMinOccurs(LayerType layer)`
`QName`	`getName()`
`String`	`getNamespace()`
`String`	`getNativeAttributeName()` Returns native attribute name.
`MappingType`	`getOutboundMappingType()`
`Boolean`	`getOverrideCanAdd()`
`Boolean`	`getOverrideCanModify()`
`Boolean`	`getOverrideCanRead()`
`com.evolveum.midpoint.prism.PrismContext`	`getPrismContext()`
`Boolean`	`getReturnedByDefault()`
`List<String>`	`getTolerantValuePattern()`
`Class`	`getTypeClass()`
`QName`	`getTypeName()`
`QName`	`getValueType()`
`int`	`hashCode()`
`boolean`	`hasOutboundMapping()`
`ResourceAttribute`	`instantiate()`
`ResourceAttribute`	`instantiate(QName name)`
`boolean`	`isAbstract()`
`boolean`	`isDeprecated()`
`boolean`	`isDynamic()`
`boolean`	`isExlusiveStrong()`
`boolean`	`isIdentifier(ObjectClassComplexTypeDefinition objectDefinition)`
`boolean`	`isIdentifier(ResourceAttributeContainerDefinition objectDefinition)` Returns true if the attribute is a (primary) identifier.
`boolean`	`isIgnored()`
`boolean`	`isIgnored(LayerType layer)`
`Boolean`	`isIndexed()`
`boolean`	`isMandatory()`
`boolean`	`isMultiValue()`
`boolean`	`isOperational()`
`boolean`	`isOptional()`
`boolean`	`isReturnedByDefault()`
`boolean`	`isRuntimeSchema()`
`boolean`	`isSecondaryIdentifier(ObjectClassComplexTypeDefinition objectDefinition)`
`boolean`	`isSingleValue()`
`boolean`	`isTolerant()`
`boolean`	`isValidFor(QName elementQName, Class<? extends com.evolveum.midpoint.prism.ItemDefinition> clazz)`
`void`	`setAttributeDefinition(ResourceAttributeDefinition attributeDefinition)`
`void`	`setCanAdd(boolean create)`
`void`	`setCanModify(boolean update)`
`void`	`setCanRead(boolean read)`
`void`	`setDescription(String description)`
`void`	`setDisplayName(String displayName)`
`void`	`setDisplayOrder(Integer displayOrder)`
`void`	`setDynamic(boolean dynamic)`
`void`	`setHelp(String help)`
`void`	`setIgnored(boolean ignored)`
`void`	`setInboundMappingTypes(List<MappingType> inboundAssignmentTypes)`
`void`	`setIndexed(Boolean indexed)`
`void`	`setMaxOccurs(int maxOccurs)`
`void`	`setMinOccurs(int minOccurs)`
`void`	`setName(QName name)`
`void`	`setNativeAttributeName(String nativeAttributeName)`
`void`	`setOutboundMappingType(MappingType outboundMappingType)`
`void`	`setOverrideCanAdd(Boolean overrideCanAdd)`
`void`	`setOverrideCanModify(Boolean overrideCanModify)`
`void`	`setOverrideCanRead(Boolean overrideCanRead)`
`void`	`setReadOnly()`
`void`	`setTolerant(boolean tolerant)`
`void`	`setTypeName(QName typeName)`

Methods inherited from class com.evolveum.midpoint.common.refinery.RefinedAttributeDefinition
isMandatory, isMultiValue, isOptional, isSecondaryIdentifier, isSingleValue, setExclusiveStrong, setFetchStrategy, setMatchingRuleQName, setReturnedByDefault, setSecondaryIdentifier, toString

Methods inherited from class com.evolveum.midpoint.schema.processor.ResourceAttributeDefinition
clone, copyDefinitionData, extendToString

Methods inherited from class com.evolveum.midpoint.prism.PrismPropertyDefinition
copyDefinitionData

Methods inherited from class com.evolveum.midpoint.prism.ItemDefinition
addNamespaceIfApplicable, adoptElementDefinitionFrom, copyDefinitionData, debugFlags, debugMultiplicity, revive, setOperational

Methods inherited from class com.evolveum.midpoint.prism.Definition
copyDefinitionData, getSchemaRegistry, getTypeClassIfKnown, isInherited, setAbstract, setDeprecated, setDocumentation, setInherited, setRuntimeSchema

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getLayer
```
public LayerType getLayer()
```
  - instantiate
```
public ResourceAttribute instantiate()
```
    Overrides:
    
    instantiate in class ResourceAttributeDefinition
  - instantiate
```
public ResourceAttribute instantiate(QName name)
```
    Overrides:
    
    instantiate in class ResourceAttributeDefinition
  - isIdentifier
```
public boolean isIdentifier(ResourceAttributeContainerDefinition objectDefinition)
```
    Description copied from class: ResourceAttributeDefinition
    
    Returns true if the attribute is a (primary) identifier. Convenience method.
    
    Overrides:
    
    isIdentifier in class ResourceAttributeDefinition
    
    Returns:
    true if the attribute is a (primary) identifier.
  - isIdentifier
```
public boolean isIdentifier(ObjectClassComplexTypeDefinition objectDefinition)
```
    Overrides:
    
    isIdentifier in class ResourceAttributeDefinition
  - setNativeAttributeName
```
public void setNativeAttributeName(String nativeAttributeName)
```
    Overrides:
    
    setNativeAttributeName in class RefinedAttributeDefinition
  - isSecondaryIdentifier
```
public boolean isSecondaryIdentifier(ObjectClassComplexTypeDefinition objectDefinition)
```
    Overrides:
    
    isSecondaryIdentifier in class ResourceAttributeDefinition
  - isTolerant
```
public boolean isTolerant()
```
    Overrides:
    
    isTolerant in class RefinedAttributeDefinition
  - setTolerant
```
public void setTolerant(boolean tolerant)
```
    Overrides:
    
    setTolerant in class RefinedAttributeDefinition
  - getOverrideCanRead
```
public Boolean getOverrideCanRead()
```
  - setOverrideCanRead
```
public void setOverrideCanRead(Boolean overrideCanRead)
```
  - getOverrideCanAdd
```
public Boolean getOverrideCanAdd()
```
  - setOverrideCanAdd
```
public void setOverrideCanAdd(Boolean overrideCanAdd)
```
  - getOverrideCanModify
```
public Boolean getOverrideCanModify()
```
  - setOverrideCanModify
```
public void setOverrideCanModify(Boolean overrideCanModify)
```
  - canAdd
```
public boolean canAdd()
```
    Overrides:
    
    canAdd in class RefinedAttributeDefinition
  - canAdd
```
public boolean canAdd(LayerType layer)
```
    Overrides:
    
    canAdd in class RefinedAttributeDefinition
  - canRead
```
public boolean canRead()
```
    Overrides:
    
    canRead in class RefinedAttributeDefinition
  - canRead
```
public boolean canRead(LayerType layer)
```
    Overrides:
    
    canRead in class RefinedAttributeDefinition
  - canModify
```
public boolean canModify()
```
    Overrides:
    
    canModify in class RefinedAttributeDefinition
  - setName
```
public void setName(QName name)
```
    Overrides:
    
    setName in class com.evolveum.midpoint.prism.ItemDefinition
  - canModify
```
public boolean canModify(LayerType layer)
```
    Overrides:
    
    canModify in class RefinedAttributeDefinition
  - setReadOnly
```
public void setReadOnly()
```
    Overrides:
    
    setReadOnly in class RefinedAttributeDefinition
  - setTypeName
```
public void setTypeName(QName typeName)
```
    Overrides:
    
    setTypeName in class com.evolveum.midpoint.prism.Definition
  - getValueType
```
public QName getValueType()
```
    Overrides:
    
    getValueType in class RefinedAttributeDefinition
  - getNamespace
```
public String getNamespace()
```
    Overrides:
    
    getNamespace in class com.evolveum.midpoint.prism.ItemDefinition
  - isIndexed
```
public Boolean isIndexed()
```
    Overrides:
    
    isIndexed in class com.evolveum.midpoint.prism.PrismPropertyDefinition
  - setMinOccurs
```
public void setMinOccurs(int minOccurs)
```
    Overrides:
    
    setMinOccurs in class RefinedAttributeDefinition
  - setMaxOccurs
```
public void setMaxOccurs(int maxOccurs)
```
    Overrides:
    
    setMaxOccurs in class RefinedAttributeDefinition
  - setCanRead
```
public void setCanRead(boolean read)
```
    Overrides:
    
    setCanRead in class RefinedAttributeDefinition
  - setCanModify
```
public void setCanModify(boolean update)
```
    Overrides:
    
    setCanModify in class RefinedAttributeDefinition
  - setIndexed
```
public void setIndexed(Boolean indexed)
```
    Overrides:
    
    setIndexed in class com.evolveum.midpoint.prism.PrismPropertyDefinition
  - getDisplayOrder
```
public Integer getDisplayOrder()
```
    Overrides:
    
    getDisplayOrder in class com.evolveum.midpoint.prism.Definition
  - isSingleValue
```
public boolean isSingleValue()
```
    Overrides:
    
    isSingleValue in class com.evolveum.midpoint.prism.ItemDefinition
  - setCanAdd
```
public void setCanAdd(boolean create)
```
    Overrides:
    
    setCanAdd in class RefinedAttributeDefinition
  - createEmptyDelta
```
public com.evolveum.midpoint.prism.delta.PropertyDelta createEmptyDelta(com.evolveum.midpoint.prism.path.ItemPath path)
```
    Overrides:
    
    createEmptyDelta in class com.evolveum.midpoint.prism.PrismPropertyDefinition
  - isMultiValue
```
public boolean isMultiValue()
```
    Overrides:
    
    isMultiValue in class com.evolveum.midpoint.prism.ItemDefinition
  - isIgnored
```
public boolean isIgnored()
```
    Overrides:
    
    isIgnored in class RefinedAttributeDefinition
  - isIgnored
```
public boolean isIgnored(LayerType layer)
```
    Overrides:
    
    isIgnored in class RefinedAttributeDefinition
  - setDisplayOrder
```
public void setDisplayOrder(Integer displayOrder)
```
    Overrides:
    
    setDisplayOrder in class com.evolveum.midpoint.prism.Definition
  - isMandatory
```
public boolean isMandatory()
```
    Overrides:
    
    isMandatory in class com.evolveum.midpoint.prism.ItemDefinition
  - setIgnored
```
public void setIgnored(boolean ignored)
```
    Overrides:
    
    setIgnored in class RefinedAttributeDefinition
  - isOptional
```
public boolean isOptional()
```
    Overrides:
    
    isOptional in class com.evolveum.midpoint.prism.ItemDefinition
  - setHelp
```
public void setHelp(String help)
```
    Overrides:
    
    setHelp in class RefinedAttributeDefinition
  - getDisplayName
```
public String getDisplayName()
```
    Overrides:
    
    getDisplayName in class RefinedAttributeDefinition
  - isDynamic
```
public boolean isDynamic()
```
    Overrides:
    
    isDynamic in class com.evolveum.midpoint.prism.ItemDefinition
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Overrides:
    
    setDisplayName in class RefinedAttributeDefinition
  - getDescription
```
public String getDescription()
```
    Overrides:
    
    getDescription in class RefinedAttributeDefinition
  - getPrismContext
```
public com.evolveum.midpoint.prism.PrismContext getPrismContext()
```
    Overrides:
    
    getPrismContext in class com.evolveum.midpoint.prism.Definition
  - setDescription
```
public void setDescription(String description)
```
    Overrides:
    
    setDescription in class RefinedAttributeDefinition
  - getTypeClass
```
public Class getTypeClass()
```
    Overrides:
    
    getTypeClass in class com.evolveum.midpoint.prism.Definition
  - getAttributeDefinition
```
public ResourceAttributeDefinition getAttributeDefinition()
```
    Overrides:
    
    getAttributeDefinition in class RefinedAttributeDefinition
  - setAttributeDefinition
```
public void setAttributeDefinition(ResourceAttributeDefinition attributeDefinition)
```
    Overrides:
    
    setAttributeDefinition in class RefinedAttributeDefinition
  - setDynamic
```
public void setDynamic(boolean dynamic)
```
    Overrides:
    
    setDynamic in class com.evolveum.midpoint.prism.ItemDefinition
  - isValidFor
```
public boolean isValidFor(QName elementQName,
                 Class<? extends com.evolveum.midpoint.prism.ItemDefinition> clazz)
```
    Overrides:
    
    isValidFor in class com.evolveum.midpoint.prism.ItemDefinition
  - getReturnedByDefault
```
public Boolean getReturnedByDefault()
```
    Overrides:
    
    getReturnedByDefault in class ResourceAttributeDefinition
  - isAbstract
```
public boolean isAbstract()
```
    Overrides:
    
    isAbstract in class com.evolveum.midpoint.prism.Definition
  - isDeprecated
```
public boolean isDeprecated()
```
    Overrides:
    
    isDeprecated in class com.evolveum.midpoint.prism.Definition
  - isOperational
```
public boolean isOperational()
```
    Overrides:
    
    isOperational in class com.evolveum.midpoint.prism.ItemDefinition
  - getDocumentation
```
public String getDocumentation()
```
    Overrides:
    
    getDocumentation in class com.evolveum.midpoint.prism.Definition
  - getDocumentationPreview
```
public String getDocumentationPreview()
```
    Overrides:
    
    getDocumentationPreview in class com.evolveum.midpoint.prism.Definition
  - isRuntimeSchema
```
public boolean isRuntimeSchema()
```
    Overrides:
    
    isRuntimeSchema in class com.evolveum.midpoint.prism.Definition
  - isReturnedByDefault
```
public boolean isReturnedByDefault()
```
    Overrides:
    
    isReturnedByDefault in class RefinedAttributeDefinition
  - getDocClassName
```
public String getDocClassName()
```
    Overrides:
    
    getDocClassName in class com.evolveum.midpoint.prism.PrismPropertyDefinition
  - isExlusiveStrong
```
public boolean isExlusiveStrong()
```
    Overrides:
    
    isExlusiveStrong in class RefinedAttributeDefinition
  - getFetchStrategy
```
public AttributeFetchStrategyType getFetchStrategy()
```
    Overrides:
    
    getFetchStrategy in class RefinedAttributeDefinition
  - getTolerantValuePattern
```
public List<String> getTolerantValuePattern()
```
    Overrides:
    
    getTolerantValuePattern in class RefinedAttributeDefinition
  - getIntolerantValuePattern
```
public List<String> getIntolerantValuePattern()
```
    Overrides:
    
    getIntolerantValuePattern in class RefinedAttributeDefinition
  - getOutboundMappingType
```
public MappingType getOutboundMappingType()
```
    Overrides:
    
    getOutboundMappingType in class RefinedAttributeDefinition
  - setOutboundMappingType
```
public void setOutboundMappingType(MappingType outboundMappingType)
```
    Overrides:
    
    setOutboundMappingType in class RefinedAttributeDefinition
  - hasOutboundMapping
```
public boolean hasOutboundMapping()
```
    Overrides:
    
    hasOutboundMapping in class RefinedAttributeDefinition
  - getInboundMappingTypes
```
public List<MappingType> getInboundMappingTypes()
```
    Overrides:
    
    getInboundMappingTypes in class RefinedAttributeDefinition
  - setInboundMappingTypes
```
public void setInboundMappingTypes(List<MappingType> inboundAssignmentTypes)
```
    Overrides:
    
    setInboundMappingTypes in class RefinedAttributeDefinition
  - getName
```
public QName getName()
```
    Overrides:
    
    getName in class RefinedAttributeDefinition
  - getTypeName
```
public QName getTypeName()
```
    Overrides:
    
    getTypeName in class RefinedAttributeDefinition
  - getNativeAttributeName
```
public String getNativeAttributeName()
```
    Description copied from class: ResourceAttributeDefinition
    
    Returns native attribute name. Native name of the attribute is a name as it is used on the resource or as seen by the connector. It is used for diagnostics purposes and may be used by the connector itself. As the attribute names in XSD have to comply with XML element name limitations, this may be the only way how to determine original attribute name. Returns null if native attribute name is not set or unknown. The name should be the same as the one used by the resource, if the resource supports naming of attributes. E.g. in case of LDAP this annotation should contain "cn", "givenName", etc. If the resource is not that flexible, the native attribute names may be hardcoded (e.g. "username", "homeDirectory") or may not be present at all.
    
    Overrides:
    
    getNativeAttributeName in class RefinedAttributeDefinition
    
    Returns:
    native attribute name
  - getAllowedValues
```
public Object[] getAllowedValues()
```
    Overrides:
    
    getAllowedValues in class RefinedAttributeDefinition
  - getMaxOccurs
```
public int getMaxOccurs()
```
    Overrides:
    
    getMaxOccurs in class RefinedAttributeDefinition
  - getMaxOccurs
```
public int getMaxOccurs(LayerType layer)
```
    Overrides:
    
    getMaxOccurs in class RefinedAttributeDefinition
  - getMinOccurs
```
public int getMinOccurs()
```
    Overrides:
    
    getMinOccurs in class RefinedAttributeDefinition
  - getMinOccurs
```
public int getMinOccurs(LayerType layer)
```
    Overrides:
    
    getMinOccurs in class RefinedAttributeDefinition
  - getLimitations
```
public PropertyLimitations getLimitations(LayerType layer)
```
    Overrides:
    
    getLimitations in class RefinedAttributeDefinition
  - getLimitations
```
public PropertyLimitations getLimitations()
```
  - getHelp
```
public String getHelp()
```
    Overrides:
    
    getHelp in class RefinedAttributeDefinition
  - getMatchingRuleQName
```
public QName getMatchingRuleQName()
```
    Overrides:
    
    getMatchingRuleQName in class RefinedAttributeDefinition
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class com.evolveum.midpoint.prism.PrismPropertyDefinition
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class com.evolveum.midpoint.prism.PrismPropertyDefinition
  - debugDump
```
public String debugDump()
```
    Description copied from interface: DebugDumpable
    
    Show the content of the object intended for diagnostics by system administrator. The out put should be suitable to use in system logs at "debug" level. It may be multi-line, but in that case it should be well indented and quite terse. As it is intended to be used by system administrator, it should not use any developer terms such as class names, exceptions or stack traces.
    
    Specified by:
    
    debugDump in interface DebugDumpable
    
    Overrides:
    
    debugDump in class com.evolveum.midpoint.prism.Definition
    
    Returns:
    content of the object intended for diagnostics by system administrator.
  - debugDump
```
public String debugDump(int indent)
```
    Specified by:
    
    debugDump in interface DebugDumpable
    
    Overrides:
    
    debugDump in class RefinedAttributeDefinition
  - getDebugDumpClassName
```
protected String getDebugDumpClassName()
```
    Return a human readable name of this class suitable for logs.
    
    Overrides:
    
    getDebugDumpClassName in class RefinedAttributeDefinition

Class LayerRefinedAttributeDefinition

Field Summary

Fields inherited from class com.evolveum.midpoint.common.refinery.RefinedAttributeDefinition

Fields inherited from class com.evolveum.midpoint.prism.ItemDefinition

Fields inherited from class com.evolveum.midpoint.prism.Definition

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

Method Summary

Methods inherited from class com.evolveum.midpoint.common.refinery.RefinedAttributeDefinition

Methods inherited from class com.evolveum.midpoint.schema.processor.ResourceAttributeDefinition

Methods inherited from class com.evolveum.midpoint.prism.PrismPropertyDefinition

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

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

Methods inherited from class java.lang.Object

Method Detail

getLayer

instantiate

instantiate

isIdentifier

isIdentifier

setNativeAttributeName

isSecondaryIdentifier

isTolerant

setTolerant

getOverrideCanRead

setOverrideCanRead

getOverrideCanAdd

setOverrideCanAdd

getOverrideCanModify

setOverrideCanModify

canAdd

canAdd

canRead

canRead

canModify

setName

canModify

setReadOnly

setTypeName

getValueType

getNamespace

isIndexed

setMinOccurs

setMaxOccurs

setCanRead

setCanModify

setIndexed

getDisplayOrder

isSingleValue

setCanAdd

createEmptyDelta

isMultiValue

isIgnored

isIgnored

setDisplayOrder

isMandatory

setIgnored

isOptional

setHelp

getDisplayName

isDynamic

setDisplayName

getDescription

getPrismContext

setDescription

getTypeClass

getAttributeDefinition

setAttributeDefinition

setDynamic

isValidFor

getReturnedByDefault

isAbstract

isDeprecated

isOperational

getDocumentation

getDocumentationPreview

isRuntimeSchema

isReturnedByDefault

getDocClassName

isExlusiveStrong

getFetchStrategy