Package com.evolveum.midpoint.schema.processor

Class NativeObjectClassUcfDefinition.Data

java.lang.Object

com.evolveum.midpoint.prism.AbstractFreezable

com.evolveum.midpoint.schema.processor.NativeObjectClassUcfDefinition.Data

All Implemented Interfaces:

Freezable, NativeObjectClassUcfDefinition, NativeObjectClassUcfDefinition.Mutable, DebugDumpable, Serializable

Enclosing interface:

NativeObjectClassUcfDefinition

public static class NativeObjectClassUcfDefinition.Data
extends AbstractFreezable
implements NativeObjectClassUcfDefinition, NativeObjectClassUcfDefinition.Mutable, Serializable, DebugDumpable

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.evolveum.midpoint.schema.processor.NativeObjectClassUcfDefinition

NativeObjectClassUcfDefinition.Data, NativeObjectClassUcfDefinition.Delegable, NativeObjectClassUcfDefinition.Mutable

Nested classes/interfaces inherited from interface com.evolveum.midpoint.schema.processor.NativeObjectClassUcfDefinition.Mutable

NativeObjectClassUcfDefinition.Mutable.Delegable

Field Summary

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

INDENT_STRING

Constructor Summary

Constructors

Constructor	Description
Data()

Method Summary

Modifier and Type	Method	Description
String	debugDump(int indent)
@Nullable QName	getDescriptionAttributeName()	Returns the name of the description attribute.
@Nullable QName	getDisplayNameAttributeName()	Returns the definition of display name attribute.
@Nullable QName	getNamingAttributeName()	Returns name of the naming attribute.
String	getNativeObjectClassName()	Returns the native object class name.
QName	getPrimaryIdentifierName()
QName	getSecondaryIdentifierName()
boolean	isAuxiliary()	Is this an auxiliary object class, i.e., a class that can be attached to an object that already holds the structural object class? This is originally an LDAP concept, but it may be applicable to other systems as well.
boolean	isDefaultAccountDefinition()	Indicates whether definition is the default account definition.
boolean	isEmbedded()	Is this an embedded object? These can only be passed "by value" in reference attributes.
void	setAuxiliary(boolean value)
void	setDefaultAccountDefinition(boolean value)
void	setDescriptionAttributeName(QName descriptionAttributeName)
void	setDisplayNameAttributeName(QName displayNameAttributeName)
void	setEmbedded(boolean value)
void	setNamingAttributeName(QName namingAttributeName)
void	setNativeObjectClassName(String value)
void	setPrimaryIdentifierName(QName value)
void	setSecondaryIdentifierName(QName value)

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

freeze, freeze, freezeAll, freezeNullableList, isImmutable, isMutable, performFreeze

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

debugDump, debugDumpLazily, debugDumpLazily

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

checkImmutable, checkMutable

Constructor Details

Data

public Data()

Method Details

getNativeObjectClassName

public String getNativeObjectClassName()

Description copied from interface: NativeObjectClassUcfDefinition

Returns the native object class name. Native object class is the name of the object class as it is seen by the resource itself. The name of the object class used in midPoint may be constrained by XSD or other syntax and therefore may be "mangled" to conform to such syntax. The _native object class_ value will contain original, un-mangled name (if available). Returns null if there is no native object class. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing.

Specified by:

getNativeObjectClassName in interface NativeObjectClassUcfDefinition

Returns:

native object class

setNativeObjectClassName

public void setNativeObjectClassName(String value)

Specified by:

setNativeObjectClassName in interface NativeObjectClassUcfDefinition.Mutable

isAuxiliary

public boolean isAuxiliary()

Description copied from interface: NativeObjectClassUcfDefinition

Is this an auxiliary object class, i.e., a class that can be attached to an object that already holds the structural object class? This is originally an LDAP concept, but it may be applicable to other systems as well.

Specified by:

isAuxiliary in interface NativeObjectClassUcfDefinition

setAuxiliary

public void setAuxiliary(boolean value)

Specified by:

setAuxiliary in interface NativeObjectClassUcfDefinition.Mutable

isEmbedded

public boolean isEmbedded()

Description copied from interface: NativeObjectClassUcfDefinition

Is this an embedded object? These can only be passed "by value" in reference attributes.

Specified by:

isEmbedded in interface NativeObjectClassUcfDefinition

setEmbedded

public void setEmbedded(boolean value)

Specified by:

setEmbedded in interface NativeObjectClassUcfDefinition.Mutable

isDefaultAccountDefinition

public boolean isDefaultAccountDefinition()

Description copied from interface: NativeObjectClassUcfDefinition

Indicates whether definition is the default account definition. (This feature is present for "dumb" resource definition that are completely without `schemaHandling` part.) This is a way how a resource connector may suggest applicable object classes. Currently the only use of this flag is that ConnId `pass:[__ACCOUNT__]` is declared as a default for the kind of `ACCOUNT`. Originally, this property was called `defaultInAKind` and marked the object class as being default for given kind. At that time, the kind was part of object class definition. This is no longer the case, therefore also this property is renamed - and is available only for account-like object classes. In the future we may put those things (kind + default-in-a-kind) back, if needed.

Specified by:

isDefaultAccountDefinition in interface NativeObjectClassUcfDefinition

setDefaultAccountDefinition

public void setDefaultAccountDefinition(boolean value)

Specified by:

setDefaultAccountDefinition in interface NativeObjectClassUcfDefinition.Mutable

getNamingAttributeName

@Nullable
public @Nullable QName getNamingAttributeName()

Description copied from interface: NativeObjectClassUcfDefinition

Returns name of the naming attribute.

Specified by:

getNamingAttributeName in interface NativeObjectClassUcfDefinition

See Also:

• NativeObjectClassUcfDefinition.getNamingAttributeName()

setNamingAttributeName

public void setNamingAttributeName(QName namingAttributeName)

Specified by:

setNamingAttributeName in interface NativeObjectClassUcfDefinition.Mutable

getDisplayNameAttributeName

@Nullable
public @Nullable QName getDisplayNameAttributeName()

Description copied from interface: NativeObjectClassUcfDefinition

Returns the definition of display name attribute. Display name attribute specifies which resource attribute should be used as title when displaying objects of a specific resource object class. It must point to an attribute of String type. If not present, primary identifier should be used instead (but this method does not handle this default behavior). Returns null if there is no display name attribute. The exception should be never thrown unless there is some bug in the code. The validation of model consistency should be done at the time of schema parsing. NOTE: Currently seems to be not used. (Neither not set nor used.)

Specified by:

getDisplayNameAttributeName in interface NativeObjectClassUcfDefinition

setDisplayNameAttributeName

public void setDisplayNameAttributeName(QName displayNameAttributeName)

Specified by:

setDisplayNameAttributeName in interface NativeObjectClassUcfDefinition.Mutable

getDescriptionAttributeName

@Nullable
public @Nullable QName getDescriptionAttributeName()

Description copied from interface: NativeObjectClassUcfDefinition

Returns the name of the description attribute. Currently seems to be unused.

Specified by:

getDescriptionAttributeName in interface NativeObjectClassUcfDefinition

setDescriptionAttributeName

public void setDescriptionAttributeName(QName descriptionAttributeName)

Specified by:

setDescriptionAttributeName in interface NativeObjectClassUcfDefinition.Mutable

getPrimaryIdentifierName

public QName getPrimaryIdentifierName()

Specified by:

getPrimaryIdentifierName in interface NativeObjectClassUcfDefinition

setPrimaryIdentifierName

public void setPrimaryIdentifierName(QName value)

Specified by:

setPrimaryIdentifierName in interface NativeObjectClassUcfDefinition.Mutable

getSecondaryIdentifierName

public QName getSecondaryIdentifierName()

Specified by:

getSecondaryIdentifierName in interface NativeObjectClassUcfDefinition

setSecondaryIdentifierName

public void setSecondaryIdentifierName(QName value)

Specified by:

setSecondaryIdentifierName in interface NativeObjectClassUcfDefinition.Mutable

debugDump

public String debugDump(int indent)

Specified by:

debugDump in interface DebugDumpable