Interface NativeObjectClassUcfDefinition.Delegable

All Superinterfaces:
NativeObjectClassUcfDefinition
All Known Implementing Classes:
NativeComplexTypeDefinitionImpl
Enclosing interface:
NativeObjectClassUcfDefinition

public static interface NativeObjectClassUcfDefinition.Delegable extends NativeObjectClassUcfDefinition
  • Method Details

    • ucfData

    • getNativeObjectClassName

      default 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
    • isAuxiliary

      default 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
    • isEmbedded

      default 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
    • isDefaultAccountDefinition

      default 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
    • getNamingAttributeName

      @Nullable default @Nullable QName getNamingAttributeName()
      Description copied from interface: NativeObjectClassUcfDefinition
      Returns name of the naming attribute.
      Specified by:
      getNamingAttributeName in interface NativeObjectClassUcfDefinition
      See Also:
    • getDisplayNameAttributeName

      @Nullable default @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
    • getDescriptionAttributeName

      @Nullable default @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
    • getPrimaryIdentifierName

      default QName getPrimaryIdentifierName()
      Specified by:
      getPrimaryIdentifierName in interface NativeObjectClassUcfDefinition
    • getSecondaryIdentifierName

      default QName getSecondaryIdentifierName()
      Specified by:
      getSecondaryIdentifierName in interface NativeObjectClassUcfDefinition