com.canto.cumulus.modules

Interface FilterModule

All Superinterfaces:

Module

public interface FilterModule
extends Module

The Module object exposes the common methods supported by filter modules:

Since:

EJaP 6.0.0

Field Summary

Fields inherited from interface com.canto.cumulus.modules.Module

MODULE_APPLICATION, MODULE_ASSET_ACTION_PACKER, MODULE_ASSET_ACTION_PROCESSOR, MODULE_ASSET_ACTION_SAVER, MODULE_ASSET_METADATA, MODULE_ASSET_PROCESSOR, MODULE_ASSET_STORAGE, MODULE_FILTER, MODULE_TYPE_MASK_ALL

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasFormatPreferencesDialog(CumulusSession cumulusSession, JPack prefsModulePreferencesPack, int formatIndexInFilter) Returns whether this module has a preference dialog for the given format.
JPack	showFormatPreferencesDialog(CumulusSession cumulusSession, JPack prefsModulePreferencesPack, int formatIndexInFilter) Show the preferences dialog using the given preferences from the module preferences pack.

Methods inherited from interface com.canto.cumulus.modules.Module

getAvailableCategoryFields, getAvailableRecordFields, getID, getName, getName, getType, hasAboutDialog, hasPreferencesDialog, isNativeModule, showAboutDialog, showPreferencesDialog

Method Detail

hasFormatPreferencesDialog

boolean hasFormatPreferencesDialog(CumulusSession cumulusSession,
                                 JPack prefsModulePreferencesPack,
                                 int formatIndexInFilter)

Returns whether this module has a preference dialog for the given format.

Parameters:

cumulusSession - session to use

prefsModulePreferencesPack - existing preferences for the format

formatIndexInFilter - format

Returns:

whether this module has a preference dialog for the given format

Since:

8.5.2

showFormatPreferencesDialog

JPack showFormatPreferencesDialog(CumulusSession cumulusSession,
                                JPack prefsModulePreferencesPack,
                                int formatIndexInFilter)

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 - existing preferences for the format

formatIndexInFilter - index of the format in the list of formats supported by this module

Returns:

The new package to be stored if modified. null if canceled.