Interface TypeDefinitionDelegator

All Superinterfaces:
AbstractTypeDefinition, Cloneable, DebugDumpable, Definition, DefinitionDelegator, Freezable, PrismLifecycleDefinition, PrismPresentationDefinition, Revivable, Serializable, SmartVisitable<Definition>, TypeDefinition, Visitable<Definition>
All Known Subinterfaces:
ComplexTypeDefinitionDelegator
All Known Implementing Classes:
TransformableComplexTypeDefinition

public interface TypeDefinitionDelegator extends DefinitionDelegator, TypeDefinition
  • Method Details

    • delegate

      TypeDefinition delegate()
      Specified by:
      delegate in interface DefinitionDelegator
    • getTypeName

      @NotNull default @NotNull QName getTypeName()
      Description copied from interface: Definition
      Returns 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:
      getTypeName in interface AbstractTypeDefinition
      Specified by:
      getTypeName in interface Definition
      Specified by:
      getTypeName in interface DefinitionDelegator
      Returns:
      the type name
    • getCompileTimeClass

      @Nullable default @Nullable Class<?> getCompileTimeClass()
      Description copied from interface: TypeDefinition
      Returns compile-time class, if this type has any. For example, UserType.class, ObjectType.class, ExtensionType.class.
      Specified by:
      getCompileTimeClass in interface TypeDefinition
    • getSuperType

      @Nullable default @Nullable QName getSuperType()
      Description copied from interface: TypeDefinition
      Name of super type of this complex type definition. For example, `c:ObjectType` is a super type for `c:FocusType` which is a super type for `c:UserType`. Extension types have `c:ExtensionType` as their supertype, if no explicit supertype is specified in XSD.
      Specified by:
      getSuperType in interface TypeDefinition
    • getStaticSubTypes

      @NotNull default @NotNull Collection<TypeDefinition> getStaticSubTypes()
      Description copied from interface: TypeDefinition
      Subtypes - but only these that are a part of the static schema. A little bit experimental. :)
      Specified by:
      getStaticSubTypes in interface TypeDefinition
    • getInstantiationOrder

      default Integer getInstantiationOrder()
      Specified by:
      getInstantiationOrder in interface TypeDefinition
    • canRepresent

      default boolean canRepresent(QName typeName)
      Specified by:
      canRepresent in interface TypeDefinition
    • getHelp

      default String getHelp()
      Description copied from interface: PrismPresentationDefinition
      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.
      Specified by:
      getHelp in interface DefinitionDelegator
      Specified by:
      getHelp in interface PrismPresentationDefinition
      Returns:
      help string or catalog key