com.evolveum.midpoint.common.refinery
Class RefinedAttributeDefinition

java.lang.Object
  extended by com.evolveum.midpoint.prism.Definition
      extended by com.evolveum.midpoint.prism.ItemDefinition
          extended by com.evolveum.midpoint.prism.PrismPropertyDefinition
              extended by com.evolveum.midpoint.schema.processor.ResourceAttributeDefinition
                  extended by com.evolveum.midpoint.common.refinery.RefinedAttributeDefinition
All Implemented Interfaces:
DebugDumpable, Dumpable, Serializable

public class RefinedAttributeDefinition
extends ResourceAttributeDefinition
implements Dumpable, DebugDumpable

Author:
semancik
See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.evolveum.midpoint.prism.ItemDefinition
name
 
Fields inherited from class com.evolveum.midpoint.prism.Definition
defaultName, displayOrder, help, ignored, prismContext, typeName
 
Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable
INDENT_STRING
 
Method Summary
 boolean canCreate()
           
 boolean canRead()
          TODO:
 boolean canUpdate()
          TODO:
 Object[] getAllowedValues()
          Returns allowed values for this property.
 ResourceAttributeDefinition getAttributeDefinition()
           
protected  String getDebugDumpClassName()
          Return a human readable name of this class suitable for logs.
 QName getDefaultName()
          Returns default name for the defined entity.
 String getDescription()
           
 String getDisplayName()
          Returns display name.
 String getHelp()
          Returns help string.
 List<MappingType> getInboundMappingTypes()
           
 int getMaxOccurs()
          Return the number of maximal value occurrences.
 int getMinOccurs()
          Return the number of minimal value occurrences.
 QName getName()
          Returns name of the defined entity.
 String getNativeAttributeName()
          Returns native attribute name.
 MappingType getOutboundMappingType()
           
 QName getTypeName()
          Returns the name of the definition type.
 QName getValueType()
          Returns QName of the property value type.
 boolean hasOutboundMapping()
           
 boolean isIgnored()
           
static boolean isIgnored(ResourceAttributeDefinitionType attrDefType)
           
 boolean isTolerant()
           
 void setAttributeDefinition(ResourceAttributeDefinition attributeDefinition)
           
 void setCreate(boolean create)
           
 void setDescription(String description)
           
 void setDisplayName(String displayName)
           
 void setHelp(String help)
           
 void setIgnored(boolean ignored)
           
 void setInboundMappingTypes(List<MappingType> inboundAssignmentTypes)
           
 void setMaxOccurs(int maxOccurs)
           
 void setMinOccurs(int minOccurs)
           
 void setNativeAttributeName(String nativeAttributeName)
           
 void setOutboundMappingType(MappingType outboundMappingType)
           
 void setRead(boolean read)
           
 void setReadOnly()
           
 void setTolerant(boolean tolerant)
           
 void setUpdate(boolean update)
           
 String toString()
           
 
Methods inherited from class com.evolveum.midpoint.schema.processor.ResourceAttributeDefinition
clone, copyDefinitionData, instantiate, instantiate, isIdentifier, isIdentifier, isSecondaryIdentifier
 
Methods inherited from class com.evolveum.midpoint.prism.PrismPropertyDefinition
copyDefinitionData, createEmptyDelta, equals, extendToString, hashCode, isIndexed, setIndexed
 
Methods inherited from class com.evolveum.midpoint.prism.ItemDefinition
copyDefinitionData, getNameOrDefaultName, getNamespace, isDynamic, isMandatory, isMultiValue, isOptional, isSingleValue, isValidFor, setDynamic, setName
 
Methods inherited from class com.evolveum.midpoint.prism.Definition
copyDefinitionData, debugDump, debugDump, dump, getDisplayOrder, getPrismContext, getSchemaRegistry, getTypeClass, setDisplayOrder, setTypeName
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.evolveum.midpoint.util.Dumpable
dump
 
Methods inherited from interface com.evolveum.midpoint.util.DebugDumpable
debugDump, debugDump
 

Method Detail

setNativeAttributeName

public void setNativeAttributeName(String nativeAttributeName)
Overrides:
setNativeAttributeName in class ResourceAttributeDefinition

isTolerant

public boolean isTolerant()

setTolerant

public void setTolerant(boolean tolerant)

canRead

public boolean canRead()
Description copied from class: PrismPropertyDefinition
TODO:

Overrides:
canRead in class PrismPropertyDefinition
Returns:

canUpdate

public boolean canUpdate()
Description copied from class: PrismPropertyDefinition
TODO:

Overrides:
canUpdate in class PrismPropertyDefinition
Returns:

setReadOnly

public void setReadOnly()
Overrides:
setReadOnly in class PrismPropertyDefinition

getValueType

public QName getValueType()
Description copied from class: PrismPropertyDefinition
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).

Overrides:
getValueType in class PrismPropertyDefinition
Returns:
QName of the property value type

setMinOccurs

public void setMinOccurs(int minOccurs)
Overrides:
setMinOccurs in class ItemDefinition

setMaxOccurs

public void setMaxOccurs(int maxOccurs)
Overrides:
setMaxOccurs in class ItemDefinition

setRead

public void setRead(boolean read)
Overrides:
setRead in class PrismPropertyDefinition

setUpdate

public void setUpdate(boolean update)
Overrides:
setUpdate in class PrismPropertyDefinition

setCreate

public void setCreate(boolean create)
Overrides:
setCreate in class PrismPropertyDefinition

canCreate

public boolean canCreate()
Overrides:
canCreate in class PrismPropertyDefinition

getDefaultName

public QName getDefaultName()
Description copied from class: Definition
Returns default name for the defined entity. The default name is the name that the entity usually takes, but a name that is not fixed by the schema. The name corresponds to the XML element name in the XML representation of the schema. It does NOT correspond to a XSD type name. For example the default name may be the element name that is usually used for a specific object (e.g. "user"), while the same object may be represented using other names that resolve to the same type. In XML representation it corresponds to "defaultElement" XSD annotation.

Overrides:
getDefaultName in class ItemDefinition
Returns:
the defaultName

isIgnored

public boolean isIgnored()
Overrides:
isIgnored in class Definition

setIgnored

public void setIgnored(boolean ignored)
Overrides:
setIgnored in class Definition

setHelp

public void setHelp(String help)
Overrides:
setHelp in class Definition

getDisplayName

public String getDisplayName()
Description copied from class: Definition
Returns 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.

Overrides:
getDisplayName in class Definition
Returns:
display name string or catalog key

setDisplayName

public void setDisplayName(String displayName)
Overrides:
setDisplayName in class Definition

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getAttributeDefinition

public ResourceAttributeDefinition getAttributeDefinition()

setAttributeDefinition

public void setAttributeDefinition(ResourceAttributeDefinition attributeDefinition)

getOutboundMappingType

public MappingType getOutboundMappingType()

setOutboundMappingType

public void setOutboundMappingType(MappingType outboundMappingType)

hasOutboundMapping

public boolean hasOutboundMapping()

getInboundMappingTypes

public List<MappingType> getInboundMappingTypes()

setInboundMappingTypes

public void setInboundMappingTypes(List<MappingType> inboundAssignmentTypes)

getName

public QName getName()
Description copied from class: ItemDefinition
Returns name of the defined entity. The name is a name of the entity instance if it is fixed by the schema. E.g. it may be a name of the property in the container that cannot be changed. The name corresponds to the XML element name in the XML representation of the schema. It does NOT correspond to a XSD type name. Name is optional. If name is not set the null value is returned. If name is not set the type is "abstract", does not correspond to the element.

Overrides:
getName in class ItemDefinition
Returns:
the name name of the entity or null.

getTypeName

public QName getTypeName()
Description copied from class: Definition
Returns the name of the definition type. Returns a name of the type for this definition. In XML representation that corresponds to the name of the XSD type.

Overrides:
getTypeName in class Definition
Returns:
the typeName

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 ResourceAttributeDefinition
Returns:
native attribute name

getAllowedValues

public Object[] getAllowedValues()
Description copied from class: PrismPropertyDefinition
Returns allowed values for this property.

Overrides:
getAllowedValues in class PrismPropertyDefinition
Returns:
Object array. May be null.

getMaxOccurs

public int getMaxOccurs()
Description copied from class: ItemDefinition
Return the number of maximal value occurrences.

Any negative number means "unbounded".

Overrides:
getMaxOccurs in class ItemDefinition
Returns:
the maxOccurs

getMinOccurs

public int getMinOccurs()
Description copied from class: ItemDefinition
Return the number of minimal value occurrences.

Overrides:
getMinOccurs in class ItemDefinition
Returns:
the minOccurs

getHelp

public String getHelp()
Description copied from class: Definition
Returns 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.

Overrides:
getHelp in class Definition
Returns:
help string or catalog key

isIgnored

public static boolean isIgnored(ResourceAttributeDefinitionType attrDefType)

toString

public String toString()
Overrides:
toString in class ResourceAttributeDefinition

getDebugDumpClassName

protected String getDebugDumpClassName()
Return a human readable name of this class suitable for logs.

Overrides:
getDebugDumpClassName in class ResourceAttributeDefinition


Copyright © 2013 evolveum. All Rights Reserved.