Package com.evolveum.midpoint.prism.deleg

Interface ItemDefinitionDelegator<I extends Item<?,?>>

All Superinterfaces:
Cloneable, DebugDumpable, Definition, DefinitionDelegator, Freezable, ItemDefinition<I>, LivePrismItemDefinition, PrismItemAccessDefinition, PrismItemBasicDefinition, PrismItemStorageDefinition, PrismLifecycleDefinition, PrismPresentationDefinition, Revivable, SchemaLookup.Aware, Serializable, SmartVisitable<Definition>, Visitable<Definition>
All Known Subinterfaces:
ContainerDefinitionDelegator<C>, ObjectDefinitionDelegator<O>, PropertyDefinitionDelegator<T>, ReferenceDefinitionDelegator, ResourceAttributeDefinitionDelegator<T>, ShadowAttributesContainerDefinitionDelegator
public interface ItemDefinitionDelegator<I extends Item<?,?>> extends DefinitionDelegator, ItemDefinition<I>, PrismItemBasicDefinition

  • Method Details

    • delegate

      ItemDefinition<I> delegate()
      Specified by:
      delegate in interface DefinitionDelegator

    • getItemName

      @NotNull default @NotNull ItemName getItemName()
      Description copied from interface: PrismItemBasicDefinition
      Gets the "canonical" name of the item for the definition. Should be qualified, if at all possible.
      Specified by:
      getItemName in interface PrismItemBasicDefinition

    • 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 Definition
      Specified by:
      getTypeName in interface DefinitionDelegator
      Specified by:
      getTypeName in interface PrismItemBasicDefinition
      Returns:
      the type name

    • 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

    • canRead

      default boolean canRead()
      Description copied from interface: PrismItemAccessDefinition
      Returns true if this item can be read (displayed). In case of containers this flag is, strictly speaking, not applicable. Container is an empty shell. What matters is access to individual sub-item. However, for containers this value has a "hint" meaning. It means that the container itself contains something that is readable. Which can be used as a hint by the presentation to display container label or block. This usually happens if the container contains at least one readable item. This does NOT mean that also all the container items can be displayed. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.

      Note: It was considered to use a different meaning for this flag - a meaning that would allow canRead()=false containers to have readable items. However, this was found not to be very useful. Therefore the "something readable inside" meaning was confirmed instead.

      Specified by:
      canRead in interface PrismItemAccessDefinition

    • getMinOccurs

      default int getMinOccurs()
      Description copied from interface: PrismItemBasicDefinition
      Returns the number of minimal value occurrences.
      Specified by:
      getMinOccurs in interface PrismItemBasicDefinition

    • getMaxOccurs

      default int getMaxOccurs()
      Description copied from interface: PrismItemBasicDefinition
      Returns the number of maximal value occurrences. Any negative number means "unbounded".
      Specified by:
      getMaxOccurs in interface PrismItemBasicDefinition

    • isOperational

      default boolean isOperational()
      Description copied from interface: ItemDefinition
      Marks operational item. Operational properties are auxiliary data (or meta-data) that are usually not modifiable by the end user. They are generated and maintained by the system. Operational items are also not usually displayed unless it is explicitly requested. The example of operational items are modification timestamps, create timestamps, user that made the last change, etc. They are also treated in a special way when comparing values. See ParameterizedEquivalenceStrategy.
      Specified by:
      isOperational in interface ItemDefinition<I extends Item<?,?>>

    • isIndexOnly

      default boolean isIndexOnly()
      Description copied from interface: PrismItemStorageDefinition
      If true, this item is not stored in XML representation in repo. TODO better name
      Specified by:
      isIndexOnly in interface PrismItemStorageDefinition

    • isIndexed

      default Boolean isIndexed()
      Description copied from interface: PrismItemStorageDefinition
      This is XSD annotation that specifies whether a property should be indexed in the storage. It can only apply to properties. It has following meaning: true: the property must be indexed. If the storage is not able to index the value, it should indicate an error. false: the property should not be indexed. null: data store decides whether to index the property or not.
      Specified by:
      isIndexed in interface PrismItemStorageDefinition

    • canModify

      default boolean canModify()
      Description copied from interface: PrismItemAccessDefinition
      Returns true if this item can be modified (updated). In case of containers this means that the container itself should be displayed in modification forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one modifiable item. This does NOT mean that also all the container items can be modified. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.
      Specified by:
      canModify in interface PrismItemAccessDefinition

    • isInherited

      default boolean isInherited()
      Description copied from interface: ItemDefinition
      Whether the item is inherited from a supertype.
      Specified by:
      isInherited in interface ItemDefinition<I extends Item<?,?>>

    • isDynamic

      default boolean isDynamic()
      Description copied from interface: ItemDefinition
      Returns true if definition was created during the runtime based on a dynamic information such as xsi:type attributes in XML. This means that the definition needs to be stored alongside the data to have a successful serialization "roundtrip". The definition is not part of any schema and therefore cannot be determined. It may even be different for every instance of the associated item (element name).
      Specified by:
      isDynamic in interface ItemDefinition<I extends Item<?,?>>

    • canAdd

      default boolean canAdd()
      Description copied from interface: PrismItemAccessDefinition
      Returns true if this item can be added: it can be part of an object that is created. In case of containers this means that the container itself should be displayed in creation forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one createable item. This does NOT mean that also all the container items can be created. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.
      Specified by:
      canAdd in interface PrismItemAccessDefinition

    • getDiagrams

      default List<ItemDiagramSpecification> getDiagrams()
      Specified by:
      getDiagrams in interface PrismPresentationDefinition

    • getSubstitutionHead

      default QName getSubstitutionHead()
      Description copied from interface: ItemDefinition
      Returns the name of an element this one can be substituted for (e.g. c:user -> c:object, s:pipeline -> s:expression, etc). EXPERIMENTAL
      Specified by:
      getSubstitutionHead in interface ItemDefinition<I extends Item<?,?>>

    • isHeterogeneousListItem

      default boolean isHeterogeneousListItem()
      Description copied from interface: ItemDefinition
      Can be used in heterogeneous lists as a list item. EXPERIMENTAL.
      Specified by:
      isHeterogeneousListItem in interface ItemDefinition<I extends Item<?,?>>

    • getValueEnumerationRef

      default PrismReferenceValue getValueEnumerationRef()
      Description copied from interface: ItemDefinition
      Reference to an object that directly or indirectly represents possible values for this item. We do not define here what exactly the object has to be. It can be a lookup table, script that dynamically produces the values or anything similar. The object must produce the values of the correct type for this item otherwise an error occurs.
      Specified by:
      getValueEnumerationRef in interface ItemDefinition<I extends Item<?,?>>

    • isValidFor

      default boolean isValidFor(@NotNull @NotNull QName elementQName, @NotNull @NotNull Class<? extends ItemDefinition<?>> clazz, boolean caseInsensitive)
      Description copied from interface: LivePrismItemDefinition
      Returns true if this definition is valid for given element name and definition class, in either case-sensitive (the default) or case-insensitive way. Used e.g. for "slow" path lookup where we iterate over all definitions in a complex type.
      Specified by:
      isValidFor in interface LivePrismItemDefinition

    • instantiate

      @NotNull default I instantiate() throws SchemaException
      Description copied from interface: ItemDefinition
      Create an item instance. Definition name or default name will be used as an element name for the instance. The instance will otherwise be empty.
      Specified by:
      instantiate in interface ItemDefinition<I extends Item<?,?>>
      Throws:
      SchemaException

    • instantiate

      @NotNull default I instantiate(QName name) throws SchemaException
      Description copied from interface: ItemDefinition
      Create an item instance. Definition name will use provided name. for the instance. The instance will otherwise be empty.
      Specified by:
      instantiate in interface ItemDefinition<I extends Item<?,?>>
      Throws:
      SchemaException

    • findItemDefinition

      default <T extends ItemDefinition<?>> T findItemDefinition(@NotNull @NotNull ItemPath path, @NotNull @NotNull Class<T> clazz)
      Description copied from interface: LivePrismItemDefinition
      Used to find a matching item definition _within_ this definition. Treats e.g. de-referencing in prism references.
      Specified by:
      findItemDefinition in interface LivePrismItemDefinition

    • createEmptyDelta

      @NotNull default @NotNull ItemDelta<?,?> createEmptyDelta(ItemPath path)
      Description copied from interface: ItemDefinition
      Creates an empty delta (with appropriate implementation class), pointing to this item definition, with a given path.
      Specified by:
      createEmptyDelta in interface ItemDefinition<I extends Item<?,?>>

    • deepClone

      default ItemDefinition<I> deepClone(@NotNull @NotNull DeepCloneOperation operation)
      Description copied from interface: ItemDefinition
      TODO document
      Specified by:
      deepClone in interface ItemDefinition<I extends Item<?,?>>

    • debugDumpShortToString

      default void debugDumpShortToString(StringBuilder sb)
      Description copied from interface: ItemDefinition
      Used in debugDumping items. Does not need to have name in it as item already has it. Does not need to have class as that is just too much info that is almost anytime pretty obvious anyway.
      Specified by:
      debugDumpShortToString in interface ItemDefinition<I extends Item<?,?>>

    • structuredType

      default Optional<ComplexTypeDefinition> structuredType()
      Description copied from interface: ItemDefinition
      Returns complex type definition of item, if underlying value is possible structured. NOTE: This seems weird, since properties and references are simple values, but actually object reference is serialized as structured value and some of properties are also.
      Specified by:
      structuredType in interface ItemDefinition<I extends Item<?,?>>

    • isSearchable

      default boolean isSearchable()
      Description copied from interface: PrismItemStorageDefinition
      Returns true if item definition is searchable.
      Specified by:
      isSearchable in interface PrismItemStorageDefinition