Package com.evolveum.midpoint.prism

Interface PrismPresentationDefinition

All Known Subinterfaces:
ComplexTypeDefinition, ComplexTypeDefinitionDelegator, CompositeObjectDefinition, CompositeObjectDefinitionDelegator, ContainerDefinitionDelegator<C>, Definition, DefinitionDelegator, EnumerationTypeDefinition, ItemDefinition<I>, ItemDefinitionDelegator<I>, ItemWrapper<I,VW>, NativeShadowAttributeDefinition, NativeShadowReferenceAttributeDefinition, NativeShadowSimpleAttributeDefinition<T>, ObjectDefinitionDelegator<O>, PrismContainerDefinition<C>, PrismContainerWrapper<C>, PrismObjectDefinition<O>, PrismObjectWrapper<O>, PrismPresentationDefinition.Delegable, PrismPropertyDefinition<T>, PrismPropertyWrapper<T>, PrismReferenceDefinition, PrismReferenceWrapper<R>, PropertyDefinitionDelegator<T>, ReferenceDefinitionDelegator, ResourceAttributeContainerDefinition, ResourceAttributeContainerDefinitionDelegator, ResourceAttributeDefinitionDelegator<T>, ResourceAttributeWrapper<T>, ResourceObjectClassDefinition, ResourceObjectClassDefinitionDelegator, ResourceObjectDefinition, ResourceObjectDefinitionDelegator, ResourceObjectTypeDefinition, ResourceObjectTypeDefinitionDelegator, ShadowAssociationsComplexTypeDefinition, ShadowAssociationsContainerDefinition, ShadowAttributeDefinition<SA,R>, ShadowAttributesComplexTypeDefinition, ShadowItemsComplexTypeDefinition, ShadowReferenceAttributeDefinition, ShadowSimpleAttributeDefinition<T>, ShadowWrapper, SimpleTypeDefinition, TypeDefinition, TypeDefinitionDelegator
All Known Implementing Classes:
AbstractResourceObjectDefinitionImpl, AssignmentHolderWrapper, CaseWorkItemTypeWrapper, CompositeObjectDefinitionImpl, com.evolveum.midpoint.prism.impl.DefinitionImpl, ExpressionWrapper, com.evolveum.midpoint.prism.impl.ItemDefinitionImpl, ItemWrapperImpl, NativeShadowAttributeDefinitionImpl, NormalizationAwareResourceAttributeDefinition, com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl, PrismContainerWrapperImpl, PrismObjectWrapperImpl, PrismPresentationDefinition.Data, PrismPropertyWrapperImpl, PrismReferenceWrapperImpl, PrismSchemaWrapper, ProfilingClassLoggerContainerWrapperImpl, ProtectedStringTypeWrapperImpl, ResourceAttributeContainerDefinitionImpl, ResourceAttributeMappingWrapper, ResourceAttributeWrapperImpl, ResourceObjectClassDefinitionImpl, ResourceObjectTypeDefinitionImpl, ResourceWrapper, ShadowAssociationsContainerDefinitionImpl, ShadowAssociationWrapperImpl, ShadowAttributeDefinitionImpl, ShadowReferenceAttributeDefinitionImpl, ShadowSimpleAttributeDefinitionImpl, ShadowWrapperImpl, ValueMetadataWrapperImpl
public interface PrismPresentationDefinition
Presentation and documentation related aspects (originally from Definition).

  • Method Details

    • getDisplayHint

      DisplayHint getDisplayHint()
      Enumeration annotation that specifies how/whether the item should be displayed. It is also a replacement for the old "emphasized" annotation.

    • isEmphasized

      boolean isEmphasized()
      True for definitions that are more important than others and that should be emphasized during presentation. E.g. the emphasized definitions will always be displayed in the user interfaces (even if they are empty), they will always be included in the dumps, etc. TODO probably deprecated, isn't it?

    • getDisplayName

      String getDisplayName()
      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.
      Returns:
      display name string or catalog key

    • getDisplayOrder

      Integer getDisplayOrder()
      Specifies an order in which the item should be displayed relative to other items at the same level. The items will be displayed by sorting them by the values of displayOrder annotation (ascending). Items that do not have any displayOrder annotation will be displayed last. The ordering of values with the same displayOrder is undefined and it may be arbitrary.

    • getHelp

      String getHelp()
      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.
      Returns:
      help string or catalog key

    • getDocumentation

      String getDocumentation()
      Must contains tag because of html tags used in text.

    • getDiagrams

      @Experimental List<ItemDiagramSpecification> getDiagrams()

    • getDocumentationPreview

      String getDocumentationPreview()
      Returns only a first sentence of documentation.

    • toDocumentationPreview

      static String toDocumentationPreview(String documentation)