ModuleDefinition (Atlassian GreenHopper 6.7.12 API)

java.lang.Object
- java.lang.Enum<ModuleDefinition>
- - com.atlassian.greenhopper.plugin.module.ModuleDefinition

All Implemented Interfaces:

Serializable, Comparable<ModuleDefinition>
```
public enum ModuleDefinition
extends Enum<ModuleDefinition>
```
Contains all the module definitions that can be dynamically loaded by the ModuleLoader based on the ModuleContext.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`AGILE_REPORTS`
`DASHBOARD_ITEMS`
`GADGETS`
`GLOBAL_SIDEBAR_ANCILLARY_LINKS_INTEGRATION`
`KEYBOARD_SHORTCUTS_63`
`KEYBOARD_SHORTCUTS_70`
`ONBOARDING`
`PROJECT_IMPORT`
`PROJECT_TEMPLATES`
`PROJECT_TEMPLATES_64`
`PROJECT_TEMPLATES_70`
`RESOURCE_CHOOSE_LANGUAGE_SEQUENCE_JIRA_65`
`RESOURCE_CHOOSE_LANGUAGE_SEQUENCE_JIRA64`
`SIDEBAR_INTEGRATION`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static List<ModuleDefinition>`	`getDefinitionsForContext(ModuleContext ctx)` Returns an List containing the module definitions applicable for the given PluginModuleContext.
`List<ModuleDefinition>`	`getDependencies()` Returns a list of ModuleDefinition that are dependencies this module relies on being loaded before it can be loaded successfully.
`String`	`getFileName()` Returns the file name of the file that contains the module's xml contribution to the plugin's atlassian-plugin.xml file.
`abstract boolean`	`isApplicable(ModuleContext ctx)` Checks if the module is applicable for the given context.
`static ModuleDefinition`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ModuleDefinition[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - GADGETS
```
public static final ModuleDefinition GADGETS
```
  - RESOURCE_CHOOSE_LANGUAGE_SEQUENCE_JIRA_65
```
public static final ModuleDefinition RESOURCE_CHOOSE_LANGUAGE_SEQUENCE_JIRA_65
```
  - RESOURCE_CHOOSE_LANGUAGE_SEQUENCE_JIRA64
```
public static final ModuleDefinition RESOURCE_CHOOSE_LANGUAGE_SEQUENCE_JIRA64
```
  - PROJECT_TEMPLATES
```
public static final ModuleDefinition PROJECT_TEMPLATES
```
  - PROJECT_TEMPLATES_64
```
public static final ModuleDefinition PROJECT_TEMPLATES_64
```
  - PROJECT_TEMPLATES_70
```
public static final ModuleDefinition PROJECT_TEMPLATES_70
```
  - SIDEBAR_INTEGRATION
```
public static final ModuleDefinition SIDEBAR_INTEGRATION
```
  - GLOBAL_SIDEBAR_ANCILLARY_LINKS_INTEGRATION
```
public static final ModuleDefinition GLOBAL_SIDEBAR_ANCILLARY_LINKS_INTEGRATION
```
  - AGILE_REPORTS
```
public static final ModuleDefinition AGILE_REPORTS
```
  - DASHBOARD_ITEMS
```
public static final ModuleDefinition DASHBOARD_ITEMS
```
  - ONBOARDING
```
public static final ModuleDefinition ONBOARDING
```
  - PROJECT_IMPORT
```
public static final ModuleDefinition PROJECT_IMPORT
```
  - KEYBOARD_SHORTCUTS_63
```
public static final ModuleDefinition KEYBOARD_SHORTCUTS_63
```
  - KEYBOARD_SHORTCUTS_70
```
public static final ModuleDefinition KEYBOARD_SHORTCUTS_70
```
- Method Detail
  - values
```
public static ModuleDefinition[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ModuleDefinition c : ModuleDefinition.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ModuleDefinition valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getDefinitionsForContext
```
public static List<ModuleDefinition> getDefinitionsForContext(ModuleContext ctx)
```
    Returns an List containing the module definitions applicable for the given PluginModuleContext. The order of the definitions in the list is based on the order they should be loaded and takes dependencies into account.
    
    Parameters:
    
    ctx -
    
    Returns:
  - getFileName
```
public String getFileName()
```
    Returns the file name of the file that contains the module's xml contribution to the plugin's atlassian-plugin.xml file. This file must be in the same folder as atlassian-plugin.xml
    
    Returns:
    
    A file name.
  - getDependencies
```
public List<ModuleDefinition> getDependencies()
```
    Returns a list of ModuleDefinition that are dependencies this module relies on being loaded before it can be loaded successfully.
    
    Returns:
  - isApplicable
```
public abstract boolean isApplicable(ModuleContext ctx)
```
    Checks if the module is applicable for the given context.
    
    Parameters:
    
    ctx -
    
    Returns:

Enum ModuleDefinition

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

GADGETS

RESOURCE_CHOOSE_LANGUAGE_SEQUENCE_JIRA_65

RESOURCE_CHOOSE_LANGUAGE_SEQUENCE_JIRA64

PROJECT_TEMPLATES

PROJECT_TEMPLATES_64

PROJECT_TEMPLATES_70

SIDEBAR_INTEGRATION

GLOBAL_SIDEBAR_ANCILLARY_LINKS_INTEGRATION

AGILE_REPORTS

DASHBOARD_ITEMS

ONBOARDING

PROJECT_IMPORT

KEYBOARD_SHORTCUTS_63

KEYBOARD_SHORTCUTS_70

Method Detail

values

valueOf

getDefinitionsForContext

getFileName

getDependencies

isApplicable