Module (Cumulus Java Classes Documentation)

All Known Subinterfaces:

AssetMetadataModule, AssetStorageModule, FilterModule
```
public interface Module
```
The Module object exposes the common methods supported by all asset handling modules: NativeModule, AssetProcessor, and AssetMetadata modules.

Since:

EJaP 6.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`MODULE_APPLICATION`
`static int`	`MODULE_ASSET_ACTION_PACKER`
`static int`	`MODULE_ASSET_ACTION_PROCESSOR`
`static int`	`MODULE_ASSET_ACTION_SAVER`
`static int`	`MODULE_ASSET_METADATA`
`static int`	`MODULE_ASSET_PROCESSOR`
`static int`	`MODULE_ASSET_STORAGE` The module type constants.
`static int`	`MODULE_FILTER`
`static int`	`MODULE_TYPE_MASK_ALL`

Method Summary

Methods
Modifier and Type	Method and Description
`FieldListEntry[]`	`getAvailableCategoryFields()` Return a list of all category fields available from this module.
`FieldListEntry[]`	`getAvailableRecordFields()` Return a list of all record fields available from this module.
`java.lang.String`	`getID()` Returns this modules ID.
`java.lang.String`	`getName()` Returns the module name for the current language.
`java.lang.String`	`getName(int languageID)` Returns the module name for the given language.
`int`	`getType()` Returns the type of this module.
`boolean`	`hasAboutDialog()` Returns whether this module has an about dialog.
`boolean`	`hasPreferencesDialog(CumulusSession cumulusSession)` Returns whether this module has a settings dialog.
`boolean`	`isNativeModule()` Returns whether this is a native module.
`void`	`showAboutDialog()` Tells the module to show its about dialog.
`JPack`	`showPreferencesDialog(CumulusSession cumulusSession, JPack prefsModulePreferencesPack)` Show the preferences dialog using the given preferences from the module preferences pack.

- Field Detail
  - MODULE_ASSET_STORAGE
```
static final int MODULE_ASSET_STORAGE
```
    The module type constants.
    
    See Also:
    Constant Field Values
  - MODULE_ASSET_PROCESSOR
```
static final int MODULE_ASSET_PROCESSOR
```
    See Also:
    Constant Field Values
  - MODULE_ASSET_METADATA
```
static final int MODULE_ASSET_METADATA
```
    See Also:
    Constant Field Values
  - MODULE_FILTER
```
static final int MODULE_FILTER
```
    See Also:
    Constant Field Values
  - MODULE_ASSET_ACTION_PROCESSOR
```
static final int MODULE_ASSET_ACTION_PROCESSOR
```
    See Also:
    Constant Field Values
  - MODULE_ASSET_ACTION_PACKER
```
static final int MODULE_ASSET_ACTION_PACKER
```
    See Also:
    Constant Field Values
  - MODULE_ASSET_ACTION_SAVER
```
static final int MODULE_ASSET_ACTION_SAVER
```
    See Also:
    Constant Field Values
  - MODULE_APPLICATION
```
static final int MODULE_APPLICATION
```
    See Also:
    Constant Field Values
  - MODULE_TYPE_MASK_ALL
```
static final int MODULE_TYPE_MASK_ALL
```
    See Also:
    Constant Field Values
- Method Detail
  - getID
```
java.lang.String getID()
```
    Returns this modules ID.
    
    Returns:
    module ID
  - isNativeModule
```
boolean isNativeModule()
```
    Returns whether this is a native module.
    
    Returns:
    true if this is a native module
  - getName
```
java.lang.String getName(int languageID)
```
    Returns the module name for the given language.
    
    Parameters:
    languageID - language ID
    
    Returns:
    name for language
  - getName
```
java.lang.String getName()
```
    Returns the module name for the current language.
    
    Returns:
    module name
  - getType
```
int getType()
```
    Returns the type of this module. The possible values are MODULE_ASSET_ACTION_PACKER, MODULE_FILTER, MODULE_ASSET_ACTION_PROCESSOR, MODULE_ASSET_ACTION_SAVER, MODULE_ASSET_METADATA, MODULE_ASSET_PROCESSOR MODULE_ASSET_STORAGE and MODULE_APPLICATION
    
    Returns:
    module type
  - hasAboutDialog
```
boolean hasAboutDialog()
```
    Returns whether this module has an about dialog.
    
    Returns:
    true if this module has an about dialog
  - showAboutDialog
```
void showAboutDialog()
```
    Tells the module to show its about dialog.
  - hasPreferencesDialog
```
boolean hasPreferencesDialog(CumulusSession cumulusSession)
```
    Returns whether this module has a settings dialog.
    
    Parameters:
    cumulusSession - session to use
    
    Returns:
    true if this module has a settings dialog
    Since:
    
    8.5.2
  - showPreferencesDialog
```
JPack showPreferencesDialog(CumulusSession cumulusSession,
                          JPack prefsModulePreferencesPack)
```
    Show the preferences dialog using the given preferences from the module preferences pack. This dialog must be modal and should only return when the dialog is closed.
    
    Parameters:
    cumulusSession - session to use
    prefsModulePreferencesPack - the settings pack for this module
    
    Returns:
    The new package to be stored if modified. null if canceled.
    Since:
    
    8.5.2
  - getAvailableRecordFields
```
FieldListEntry[] getAvailableRecordFields()
```
    Return a list of all record fields available from this module.
    
    Returns:
    An array of fields defined by this module.
  - getAvailableCategoryFields
```
FieldListEntry[] getAvailableCategoryFields()
```
    Return a list of all category fields available from this module.
    
    Returns:
    An array of fields defined by this module.

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Interface Module

Field Summary

Method Summary

Field Detail

MODULE_ASSET_STORAGE

MODULE_ASSET_PROCESSOR

MODULE_ASSET_METADATA

MODULE_FILTER

MODULE_ASSET_ACTION_PROCESSOR

MODULE_ASSET_ACTION_PACKER

MODULE_ASSET_ACTION_SAVER

MODULE_APPLICATION

MODULE_TYPE_MASK_ALL

Method Detail

getID

isNativeModule

getName

getName

getType

hasAboutDialog

showAboutDialog

hasPreferencesDialog

showPreferencesDialog

getAvailableRecordFields

getAvailableCategoryFields