ModuleRegistry (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.modules.ModuleRegistry

```
public class ModuleRegistry
extends java.lang.Object
```
The global registry for all native modules. It contains all registered Filters, AssetProcessors and AssetStorages.

Since:

EJaP 6.0.0

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`allocateModuleLicense(CumulusSession session, int productID)` Allocate an option's license with the given product ID.
`Module`	`findModuleByID(CumulusSession session, java.lang.String id, int type)` Deprecated. Use `findModuleByID(String, int)` instead
`Module`	`findModuleByID(java.lang.String id, int type)` Return a registered module with the given ID.
`java.util.Collection<Module>`	`getAssetMetadataModules()` Return a list of all Asset Metadata modules.
`java.util.Collection<Module>`	`getAssetMetadataModules(CumulusSession session)` Deprecated. Use `getAssetMetadataModules()` instead
`java.util.Collection<Module>`	`getAssetProcessorModules()` Return a list of all Asset Processor modules.
`java.util.Collection<Module>`	`getAssetProcessorModules(CumulusSession session)` Deprecated. Use `getAssetProcessorModules()` instead
`java.util.Collection<Module>`	`getAssetStorageModules()` Return a list of all Asset Storage modules.
`java.util.Collection<Module>`	`getAssetStorageModules(CumulusSession session)` Deprecated. Use `getAssetStorageModules()` instead
`void`	`getAvailableAssetFormats(AssetFormatsList assetFormatsList, ModulePreferencesList modulePreferencesList)` Return a complete asset formats list.
`void`	`getAvailableAssetFormats(CumulusSession session, AssetFormatsList assetFormatsList, ModulePreferencesList modulePreferencesList)` Deprecated. Use `getAvailableAssetFormats(com.canto.cumulus.prefs.AssetFormatsList, com.canto.cumulus.prefs.ModulePreferencesList)` instead
`FieldList`	`getAvailableCategoryFields(CumulusSession session)` Return a list of all category fields available from registered modules.
`java.util.List<FieldListEntry>`	`getAvailableCategoryFieldsAsList()` Returns a list of all available category fields.
`java.util.List<FieldListEntry>`	`getAvailableCategoryFieldsAsList(CumulusSession session)` Deprecated. Use `getAvailableCategoryFieldsAsList()` instead
`java.util.Map<GUID,FieldListEntry>`	`getAvailableCategoryFieldsAsMap()` Returns a map of all available category fields.
`java.util.List<FieldListEntry>`	`getAvailableDistinctNamedCategoryFieldsAsList()` Returns a list of all available category fields with a unique name.
`java.util.List<FieldListEntry>`	`getAvailableDistinctNamedCategoryFieldsAsList(CumulusSession session)` Deprecated. Use `getAvailableDistinctNamedCategoryFieldsAsList()` instead
`java.util.List<FieldListEntry>`	`getAvailableDistinctNamedRecordFieldsAsList()` Returns a list of all available record fields with a unique name.
`java.util.List<FieldListEntry>`	`getAvailableDistinctNamedRecordFieldsAsList(CumulusSession session)` Deprecated. Use `getAvailableDistinctNamedRecordFieldsAsList()` instead
`java.util.List<FieldListEntry>`	`getAvailableDistinctNamedSortableCategoryFieldsAsList()` Returns a list of all available category fields with a unique name that are sortable.
`java.util.List<FieldListEntry>`	`getAvailableDistinctNamedSortableCategoryFieldsAsList(CumulusSession session)` Deprecated. Use `getAvailableDistinctNamedSortableCategoryFieldsAsList()` instead
`java.util.List<FieldListEntry>`	`getAvailableDistinctNamedSortableRecordFieldsAsList()` Returns a list of all available record fields with a unique name that are sortable.
`java.util.List<FieldListEntry>`	`getAvailableDistinctNamedSortableRecordFieldsAsList(CumulusSession session)` Deprecated. Use `getAvailableDistinctNamedSortableRecordFieldsAsList()` instead
`FieldList`	`getAvailableRecordFields(CumulusSession session)` Return a list of all record fields available from registered modules.
`java.util.List<FieldListEntry>`	`getAvailableRecordFieldsAsList()` Returns a list of all available record fields.
`java.util.List<FieldListEntry>`	`getAvailableRecordFieldsAsList(CumulusSession session)` Deprecated. Use `getAvailableRecordFieldsAsList()` instead
`java.util.Map<GUID,FieldListEntry>`	`getAvailableRecordFieldsAsMap()` Returns a map of all available record fields.
`java.util.Collection<Module>`	`getFilterModules()` Return a list of all Filter modules.
`java.util.Collection<Module>`	`getFilterModules(CumulusSession session)` Deprecated. Use `getFilterModules()` instead
`static ModuleRegistry`	`getInstance()` Returns the singleton instance of the registry.
`Module`	`getModule(GUID moduleUID)`
`java.util.Collection<Module>`	`getModules(CumulusSession session, int typeMask)` Deprecated. use `getModules(int)` instead
`java.util.Collection<Module>`	`getModules(int typeMask)` Return a list of all registered modules that fall into one of the given types.
`void`	`releaseModuleLicense(CumulusSession session, int productID)` Release a license previously allocated using the `allocateModuleLicense(com.canto.cumulus.CumulusSession, int)` method.
`void`	`updateAssetFormatsList(AssetFormatsList assetFormatsList, boolean addNewFormatsAutomatically, ModulePreferencesList modulePreferencesList)` Return an updated version of the asset formats list.
`void`	`updateAssetFormatsList(CumulusSession session, AssetFormatsList assetFormatsList, boolean addNewFormatsAutomatically, ModulePreferencesList modulePreferencesList)` Deprecated. Use `updateAssetFormatsList1(com.canto.cumulus.utils.JPack, boolean, com.canto.cumulus.utils.JPack)` instead

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

- Method Detail
  - getInstance
```
public static ModuleRegistry getInstance()
```
    Returns the singleton instance of the registry.
    
    Returns:
    registry instance
  - getAssetStorageModules
```
@Deprecated
public java.util.Collection<Module> getAssetStorageModules(CumulusSession session)
```
    Deprecated. Use getAssetStorageModules() instead
    
    Return a list of all Asset Storage modules.
    
    Parameters:
    session - the CumulusSession to use. This object holds the preferences used to build the list.
    
    Returns:
    A collection of Module objects.
  - getAssetStorageModules
```
public java.util.Collection<Module> getAssetStorageModules()
```
    Return a list of all Asset Storage modules.
    
    Returns:
    A collection of Module objects.
    Since:
    
    9.2
  - getAssetProcessorModules
```
@Deprecated
public java.util.Collection<Module> getAssetProcessorModules(CumulusSession session)
```
    Deprecated. Use getAssetProcessorModules() instead
    
    Return a list of all Asset Processor modules.
    
    Parameters:
    session - the CumulusSession to use. This object holds the preferences used to build the list.
    
    Returns:
    A collection of Module objects.
  - getAssetProcessorModules
```
public java.util.Collection<Module> getAssetProcessorModules()
```
    Return a list of all Asset Processor modules.
    
    Returns:
    A collection of Module objects.
    Since:
    
    9.2
  - getAssetMetadataModules
```
@Deprecated
public java.util.Collection<Module> getAssetMetadataModules(CumulusSession session)
```
    Deprecated. Use getAssetMetadataModules() instead
    
    Return a list of all Asset Metadata modules.
    
    Parameters:
    session - the CumulusSession to use. This object holds the preferences used to build the list.
    
    Returns:
    A collection of AssetMetadataModule objects.
  - getAssetMetadataModules
```
public java.util.Collection<Module> getAssetMetadataModules()
```
    Return a list of all Asset Metadata modules.
    
    Returns:
    A collection of AssetMetadataModule objects.
    Since:
    
    9.2
  - getFilterModules
```
@Deprecated
public java.util.Collection<Module> getFilterModules(CumulusSession session)
```
    Deprecated. Use getFilterModules() instead
    
    Return a list of all Filter modules.
    
    Parameters:
    session - the CumulusSession to use. This object holds the preferences used to build the list.
    
    Returns:
    A collection of Module objects.
  - getFilterModules
```
public java.util.Collection<Module> getFilterModules()
```
    Return a list of all Filter modules.
    
    Returns:
    A collection of Module objects.
    Since:
    
    9.2
  - getModules
```
@Deprecated
public java.util.Collection<Module> getModules(CumulusSession session,
                                                 int typeMask)
```
    Deprecated. use getModules(int) instead
    
    Return a list of all registered modules that fall into one of the given types.
    Parameters:
    session - the CumulusSession to use. This object holds the preferences used to build the list.
    typeMask - A combination of the following types:
    
    Module.MODULE_ASSET_STORAGE
    
    Module.MODULE_ASSET_PROCESSOR
    
    Module.MODULE_ASSET_METADATA
    
    Module.MODULE_FILTER
    
    Module.MODULE_ASSET_ACTION_PACKER
    
    Module.MODULE_ASSET_ACTION_PROCESSOR
    
    Module.MODULE_ASSET_ACTION_SAVER
    Returns:
    A collection of Module objects.
  - getModules
```
public java.util.Collection<Module> getModules(int typeMask)
```
    Return a list of all registered modules that fall into one of the given types.
    Parameters:
    typeMask - A combination of the following types:
    
    Module.MODULE_ASSET_STORAGE
    
    Module.MODULE_ASSET_PROCESSOR
    
    Module.MODULE_ASSET_METADATA
    
    Module.MODULE_FILTER
    
    Module.MODULE_ASSET_ACTION_PACKER
    
    Module.MODULE_ASSET_ACTION_PROCESSOR
    
    Module.MODULE_ASSET_ACTION_SAVER
    Returns:
    A collection of Module objects.
    Since:
    
    9.2
  - getModule
```
public Module getModule(GUID moduleUID)
```
  - findModuleByID
```
@Deprecated
public Module findModuleByID(CumulusSession session,
                               java.lang.String id,
                               int type)
```
    Deprecated. Use findModuleByID(String, int) instead
    
    Return a registered module with the given ID.
    
    Parameters:
    session - the CumulusSession to use.
    id - requested modules id
    type - The module type to return. If a module supports multiple module types only the entry for the given type is returned.
    
    Returns:
    It the module is found it returns a Module object. Otherwise it returns null.
  - findModuleByID
```
public Module findModuleByID(java.lang.String id,
                    int type)
```
    Return a registered module with the given ID.
    
    Parameters:
    id - requested modules id
    type - The module type to return. If a module supports multiple module types only the entry for the given type is returned.
    
    Returns:
    It the module is found it returns a Module object. Otherwise it returns null.
    Since:
    
    9.2
  - updateAssetFormatsList
```
@Deprecated
public void updateAssetFormatsList(CumulusSession session,
                                     AssetFormatsList assetFormatsList,
                                     boolean addNewFormatsAutomatically,
                                     ModulePreferencesList modulePreferencesList)
```
    Deprecated. Use updateAssetFormatsList1(com.canto.cumulus.utils.JPack, boolean, com.canto.cumulus.utils.JPack) instead
    
    Return an updated version of the asset formats list.
    
    Parameters:
    session - the CumulusSession to work on
    assetFormatsList - the asset format list to update. The method modifies this object.
    addNewFormatsAutomatically - Specify whether new formats are added automatically at runtime
    modulePreferencesList - the filter list containing the module settings.
  - updateAssetFormatsList
```
public void updateAssetFormatsList(AssetFormatsList assetFormatsList,
                          boolean addNewFormatsAutomatically,
                          ModulePreferencesList modulePreferencesList)
```
    Return an updated version of the asset formats list.
    
    Parameters:
    assetFormatsList - the asset format list to update. The method modifies this object.
    addNewFormatsAutomatically - Specify whether new formats are added automatically at runtime
    modulePreferencesList - the filter list containing the module settings.
    Since:
    
    9.2
  - getAvailableAssetFormats
```
@Deprecated
public void getAvailableAssetFormats(CumulusSession session,
                                       AssetFormatsList assetFormatsList,
                                       ModulePreferencesList modulePreferencesList)
```
    Deprecated. Use getAvailableAssetFormats(com.canto.cumulus.prefs.AssetFormatsList, com.canto.cumulus.prefs.ModulePreferencesList) instead
    
    Return a complete asset formats list.
    
    Parameters:
    session - the CumulusSession to work on
    modulePreferencesList - the filter list containing the module settings.
    assetFormatsList - the asset format list to update. The method modifies this object.
  - getAvailableAssetFormats
```
public void getAvailableAssetFormats(AssetFormatsList assetFormatsList,
                            ModulePreferencesList modulePreferencesList)
```
    Return a complete asset formats list.
    
    Parameters:
    modulePreferencesList - the filter list containing the module settings.
    assetFormatsList - the asset format list to update. The method modifies this object.
    Since:
    
    9.2
  - getAvailableRecordFields
```
public FieldList getAvailableRecordFields(CumulusSession session)
```
    Return a list of all record fields available from registered modules.
    
    Parameters:
    session - the CumulusSession to use. This object holds the preferences used to build the list.
    
    Returns:
    A list of fields defined by registered modules.
  - getAvailableRecordFieldsAsList
```
@Deprecated
public java.util.List<FieldListEntry> getAvailableRecordFieldsAsList(CumulusSession session)
```
    Deprecated. Use getAvailableRecordFieldsAsList() instead
    
    Returns a list of all available record fields.
    
    Parameters:
    session - the session to work with
    
    Returns:
    list of FieldListEntry instances
  - getAvailableRecordFieldsAsList
```
public java.util.List<FieldListEntry> getAvailableRecordFieldsAsList()
```
    Returns a list of all available record fields.
    
    Returns:
    list of FieldListEntry instances
    Since:
    
    9.2
  - getAvailableRecordFieldsAsMap
```
public java.util.Map<GUID,FieldListEntry> getAvailableRecordFieldsAsMap()
```
    Returns a map of all available record fields.
    
    Returns:
    map of FieldListEntry instances
    Since:
    
    9.2
  - getAvailableDistinctNamedRecordFieldsAsList
```
@Deprecated
public java.util.List<FieldListEntry> getAvailableDistinctNamedRecordFieldsAsList(CumulusSession session)
```
    Deprecated. Use getAvailableDistinctNamedRecordFieldsAsList() instead
    
    Returns a list of all available record fields with a unique name.
    
    Parameters:
    session - the session to work with
    
    Returns:
    list of FieldListEntry instances
  - getAvailableDistinctNamedRecordFieldsAsList
```
public java.util.List<FieldListEntry> getAvailableDistinctNamedRecordFieldsAsList()
```
    Returns a list of all available record fields with a unique name.
    
    Returns:
    list of FieldListEntry instances
    Since:
    
    9.2
  - getAvailableDistinctNamedSortableRecordFieldsAsList
```
@Deprecated
public java.util.List<FieldListEntry> getAvailableDistinctNamedSortableRecordFieldsAsList(CumulusSession session)
```
    Deprecated. Use getAvailableDistinctNamedSortableRecordFieldsAsList() instead
    
    Returns a list of all available record fields with a unique name that are sortable.
    
    Parameters:
    session - the session to work with
    
    Returns:
    list of FieldListEntry instances
  - getAvailableDistinctNamedSortableRecordFieldsAsList
```
public java.util.List<FieldListEntry> getAvailableDistinctNamedSortableRecordFieldsAsList()
```
    Returns a list of all available record fields with a unique name that are sortable.
    
    Returns:
    list of FieldListEntry instances
    Since:
    
    9.2
  - getAvailableCategoryFieldsAsMap
```
public java.util.Map<GUID,FieldListEntry> getAvailableCategoryFieldsAsMap()
```
    Returns a map of all available category fields.
    
    Returns:
    map of FieldListEntry instances
    Since:
    
    9.2
  - getAvailableCategoryFieldsAsList
```
@Deprecated
public java.util.List<FieldListEntry> getAvailableCategoryFieldsAsList(CumulusSession session)
```
    Deprecated. Use getAvailableCategoryFieldsAsList() instead
    
    Returns a list of all available category fields.
    
    Parameters:
    session - the session to work with
    
    Returns:
    list of FieldListEntry instances
  - getAvailableCategoryFieldsAsList
```
public java.util.List<FieldListEntry> getAvailableCategoryFieldsAsList()
```
    Returns a list of all available category fields.
    
    Returns:
    list of FieldListEntry instances
    Since:
    
    9.2
  - getAvailableDistinctNamedCategoryFieldsAsList
```
@Deprecated
public java.util.List<FieldListEntry> getAvailableDistinctNamedCategoryFieldsAsList(CumulusSession session)
```
    Deprecated. Use getAvailableDistinctNamedCategoryFieldsAsList() instead
    
    Returns a list of all available category fields with a unique name.
    
    Parameters:
    session - the session to work with
    
    Returns:
    list of FieldListEntry instances
  - getAvailableDistinctNamedCategoryFieldsAsList
```
public java.util.List<FieldListEntry> getAvailableDistinctNamedCategoryFieldsAsList()
```
    Returns a list of all available category fields with a unique name.
    
    Returns:
    list of FieldListEntry instances
    Since:
    
    9.2
  - getAvailableDistinctNamedSortableCategoryFieldsAsList
```
@Deprecated
public java.util.List<FieldListEntry> getAvailableDistinctNamedSortableCategoryFieldsAsList(CumulusSession session)
```
    Deprecated. Use getAvailableDistinctNamedSortableCategoryFieldsAsList() instead
    
    Returns a list of all available category fields with a unique name that are sortable.
    
    Parameters:
    session - the session to work with
    
    Returns:
    list of FieldListEntry instances
  - getAvailableDistinctNamedSortableCategoryFieldsAsList
```
public java.util.List<FieldListEntry> getAvailableDistinctNamedSortableCategoryFieldsAsList()
```
    Returns a list of all available category fields with a unique name that are sortable.
    
    Returns:
    list of FieldListEntry instances
    Since:
    
    9.2
  - getAvailableCategoryFields
```
public FieldList getAvailableCategoryFields(CumulusSession session)
```
    Return a list of all category fields available from registered modules.
    
    Parameters:
    session - the CumulusSession to use. This object holds the preferences used to build the list.
    
    Returns:
    A list of fields defined by registered modules.
  - allocateModuleLicense
```
public boolean allocateModuleLicense(CumulusSession session,
                            int productID)
```
    Allocate an option's license with the given product ID. Product IDs can be obtained contacting Canto. In the Enterprise or Workgroup Edition of Cumulus the product needs to be licensed at the Cumulus server. In the Single User Edition of Cumulus the license needs to be added locally. The license is allocated in the scope of the given session. In the Cumulus Client application the session must be obtained from a Cumulus object that is connected to a Cumulus server (e.g. a RecordCollection object). The license is automatically released when the session is closed. You can manually release the license using the releaseModuleLicense(com.canto.cumulus.CumulusSession, int) method.
    
    Parameters:
    session - The CumulusSession object to act as an allocation scope for the license.
    productID - The product ID number for the license.
    
    Returns:
    Return true if a license has been allocated. Return false otherwise.
  - releaseModuleLicense
```
public void releaseModuleLicense(CumulusSession session,
                        int productID)
```
    Release a license previously allocated using the allocateModuleLicense(com.canto.cumulus.CumulusSession, int) method.
    
    Parameters:
    session - The CumulusSession object the license was allocated to.
    productID - The product ID number for the license.

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.

Class ModuleRegistry

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getInstance

getAssetStorageModules

getAssetStorageModules

getAssetProcessorModules

getAssetProcessorModules

getAssetMetadataModules

getAssetMetadataModules

getFilterModules

getFilterModules

getModules

getModules

getModule

findModuleByID

findModuleByID

updateAssetFormatsList

updateAssetFormatsList

getAvailableAssetFormats

getAvailableAssetFormats

getAvailableRecordFields

getAvailableRecordFieldsAsList

getAvailableRecordFieldsAsList

getAvailableRecordFieldsAsMap

getAvailableDistinctNamedRecordFieldsAsList

getAvailableDistinctNamedRecordFieldsAsList

getAvailableDistinctNamedSortableRecordFieldsAsList

getAvailableDistinctNamedSortableRecordFieldsAsList

getAvailableCategoryFieldsAsMap

getAvailableCategoryFieldsAsList

getAvailableCategoryFieldsAsList

getAvailableDistinctNamedCategoryFieldsAsList

getAvailableDistinctNamedCategoryFieldsAsList

getAvailableDistinctNamedSortableCategoryFieldsAsList

getAvailableDistinctNamedSortableCategoryFieldsAsList

getAvailableCategoryFields

allocateModuleLicense

releaseModuleLicense