Package com.atlassian.jira.plugin.userformat

Interface UserFormatModuleDescriptor

All Superinterfaces:
JiraResourcedModuleDescriptor<UserFormat>, com.atlassian.plugin.ModuleDescriptor<UserFormat>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware
All Known Implementing Classes:
UserFormatModuleDescriptorImpl
public interface UserFormatModuleDescriptor extends JiraResourcedModuleDescriptor<UserFormat>

A module descriptor that produces a UserFormat that can be used to format a user for display. The provided user formats are tied to a "type".

There can be many user formats for a specific "type", but only one of them will be used when formatting the user name.

Administrators configure which user format to use for a specific type in UI.

Since:
v4.4
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getType()
    Gets the user format "type" that this descriptor applies to.
    String
    getTypeI18nKey()
    Gets an i18n key to display a user friendly description for the type that this descriptor applies to.

    Methods inherited from interface com.atlassian.jira.plugin.JiraResourcedModuleDescriptor

    getHtml, getHtml, getI18nBean, writeHtml

    Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

    destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getDisplayName, getI18nNameKey, getKey, getMinJavaVersion, getModule, getModuleClass, getName, getParams, getPlugin, getPluginKey, hashCode, init, isBroken, isEnabled, isEnabledByDefault, isSystemModule, satisfiesMinJavaVersion, setBroken

    Methods inherited from interface com.atlassian.plugin.Resourced

    getResourceDescriptor, getResourceDescriptors, getResourceLocation

    Methods inherited from interface com.atlassian.plugin.ScopeAware

    getScopeKey

  • Method Details

    • getType

      String getType()
      Gets the user format "type" that this descriptor applies to.
      Returns:
      The user format "type" for this descriptor.

    • getTypeI18nKey

      String getTypeI18nKey()
      Gets an i18n key to display a user friendly description for the type that this descriptor applies to.
      Returns:
      An i18n key to display a user friendly description for the type.