PluginApplicationMetaData (Atlassian Application

```
public interface PluginApplicationMetaData
```
The meta-data about an Application provided by a set of plugins. There are three types of plugins:
- Primary Plugin: The plugin that defines the application. Disabling this plugin will will disable the application. There is only one primary plugin per application. The primary plugin may also provide application functionality.
- Application Plugin: A plugin providing fundamental features for the application. All application plugins must be enabled and working for the application to be considered working. The application plugin is owned by the application (aka the plugin will not work without the primary of the application).
- Utility Plugin: A plugin that provides utilities to the primary and/or application plugins. A utility plugin is not owned by the application (i.e. the plugin will work without the primary of the application) and may be used by multiple applications or other plugins
Unless otherwise noted none of the parameters or return values can be null.
Since:

v1.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`org.joda.time.DateTime`	`buildDate()` Return the build date of the application.
`Iterable<ApplicationPlugin>`	`getApplicationPlugins()` Return all the application plugins in the application.
`io.atlassian.fugue.Option<URI>`	`getConfigurationURI()` Get the relative URI for the configuration of the application.
`String`	`getDefaultGroup()` Get the default user group defined for the application.
`String`	`getDefinitionModuleKey()` Return the module key for the module in the Primary plugin that defines the application.
`String`	`getDescriptionKey()` Get the description of the application as an i18n key.
`ApplicationKey`	`getKey()` Return the `ApplicationKey` associated with the Application.
`String`	`getName()` Get the name of the application.
`Iterable<ApplicationPlugin>`	`getPlugins()` Get the primary, application and utility plugins associated with the application.
`io.atlassian.fugue.Option<URI>`	`getPostInstallURI()` Get the relative URI to show after the application is installed.
`io.atlassian.fugue.Option<URI>`	`getPostUpdateURI()` Get the relative URI to show after the application is updated.
`ApplicationPlugin`	`getPrimaryPlugin()` Get the primary plugin associated in the application.
`io.atlassian.fugue.Option<URI>`	`getProductHelpCloudSpaceURI()` Returns relative URI to use as target space for product user helplinks in cloud.
`io.atlassian.fugue.Option<URI>`	`getProductHelpServerSpaceURI()` Returns relative URI to use as target space for product user helplinks.
`String`	`getUserCountKey()` Returns a key can be used to generate internationalised description for a passed number of users.
`Iterable<ApplicationPlugin>`	`getUtilityPlugins()` Return all the utility plugins in the application.
`String`	`getVersion()` Get the version of the application.

- Method Detail
  - getKey
```
ApplicationKey getKey()
```
    Return the ApplicationKey associated with the Application.
    
    Returns:
    
    the ApplicationKey associated with the Application.
  - getName
```
String getName()
```
    Get the name of the application.
    
    Returns:
    
    the name of the application. Must not be internationalised.
  - getVersion
```
String getVersion()
```
    Get the version of the application.
    In the case of plugin applications, this will be the version of the primary plugin.
    
    Returns:
    
    the version of the application.
  - getDescriptionKey
```
String getDescriptionKey()
```
    Get the description of the application as an i18n key.
    
    Returns:
    
    the description of the application as an i18n key.
  - getUserCountKey
```
String getUserCountKey()
```
    Returns a key can be used to generate internationalised description for a passed number of users. For example, JIRA Service Desk might return "agent" for a count of 1 or "agents" for a count of 2 or more. A value of -1 is passed to try and find the "unlimited" users.
    
    Returns:
    
    the internationalised name of the passed number of users.
  - getConfigurationURI
```
io.atlassian.fugue.Option<URI> getConfigurationURI()
```
    Get the relative URI for the configuration of the application. The context path must not be included.
    Option.none() can be returned to indicate that there is no configuration path.
    
    Returns:
    
    the relative URI to the configuration page minus the context path or Option.none() if no such path exists.
  - getPostInstallURI
```
io.atlassian.fugue.Option<URI> getPostInstallURI()
```
    Get the relative URI to show after the application is installed. The context path must not be included.
    Option.none() can be returned to indicate that there is no path.
    
    Returns:
    
    the relative URI to the post install page minus the context path or Option.none() if no such path exists.
  - getPostUpdateURI
```
io.atlassian.fugue.Option<URI> getPostUpdateURI()
```
    Get the relative URI to show after the application is updated. The context path must not be included.
    Option.none() can be returned to indicate that there is no path.
    
    Returns:
    
    the relative URI to the post update page minus the context path or Option.none() if no such path exists.
  - buildDate
```
org.joda.time.DateTime buildDate()
```
    Return the build date of the application.
    
    Returns:
    
    the build date of the application. Epoch (i.e. new DateTime(0)) will be returned if the build date is unknown.
  - getDefinitionModuleKey
```
String getDefinitionModuleKey()
```
    Return the module key for the module in the Primary plugin that defines the application. The plugin key must be included.
    
    Returns:
    
    the module key to the module in the Primary plugin that defines the application.
  - getPlugins
```
Iterable<ApplicationPlugin> getPlugins()
```
    Get the primary, application and utility plugins associated with the application.
    
    Returns:
    
    the primary, application and utility plugins associated with the application.
  - getPrimaryPlugin
```
ApplicationPlugin getPrimaryPlugin()
```
    Get the primary plugin associated in the application.
    
    Returns:
    
    the primary plugin for the application.
  - getApplicationPlugins
```
Iterable<ApplicationPlugin> getApplicationPlugins()
```
    Return all the application plugins in the application.
    
    Returns:
    
    the application plugins in the application. Can be empty if the primary provides all the functionality of the application.
  - getUtilityPlugins
```
Iterable<ApplicationPlugin> getUtilityPlugins()
```
    Return all the utility plugins in the application.
    
    Returns:
    
    the utility plugins in the application. Can be empty.
  - getDefaultGroup
```
String getDefaultGroup()
```
    Get the default user group defined for the application.
    
    Returns:
    
    the default user group of the application.
  - getProductHelpServerSpaceURI
```
io.atlassian.fugue.Option<URI> getProductHelpServerSpaceURI()
```
    Returns relative URI to use as target space for product user helplinks.
    Option.none() can be returned to indicate that there is no server help space.
    
    Returns:
    
    the server help space to point product user helplinks to Option.none() if no such space exists.
  - getProductHelpCloudSpaceURI
```
io.atlassian.fugue.Option<URI> getProductHelpCloudSpaceURI()
```
    Returns relative URI to use as target space for product user helplinks in cloud.
    Option.none() can be returned to indicate that there is no cloud help space.
    
    Returns:
    
    the cloud help space to point product user helplinks to Option.none() if no such space exists.

Interface PluginApplicationMetaData

Method Summary

Method Detail

getKey

getName

getVersion

getDescriptionKey

getUserCountKey

getConfigurationURI

getPostInstallURI

getPostUpdateURI

buildDate

getDefinitionModuleKey

getPlugins

getPrimaryPlugin

getApplicationPlugins

getUtilityPlugins

getDefaultGroup

getProductHelpServerSpaceURI

getProductHelpCloudSpaceURI