Preferences (Cumulus Java Classes Documentation)

All Known Implementing Classes:

PreferencesImpl
```
public interface Preferences
```
This interfaces describes the methods available when accessing the preferences of Cumulus.

Since:

EJaP 6.0.0

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addPreferencesChangeListener(PreferencesChangeListener preferencesChangeListener, java.lang.String listenerPath)` Add a listener for preferences changes for the specified path.
`AssetAction`	`getAssetAction(java.lang.String name)` Returns the asset action with the specified name.
`java.util.Collection<java.lang.String>`	`getAssetActionNames()` Returns a collection of all asset action names available.
`java.util.Collection<AssetAction>`	`getAssetActions()` Returns a collection of all asset actions available.
`AssetHandlingSet`	`getAssetHandlingSet(java.lang.String name)` Returns the asset handling set with the specified name.
`java.util.Collection<java.lang.String>`	`getAssetHandlingSetNames()` Returns a collection of all asset handling set names available.
`java.util.Collection<AssetHandlingSet>`	`getAssetHandlingSets()` Returns a collection of all asset handling sets available.
`CatalogTemplate`	`getCatalogTemplate(java.lang.String name)` Returns the catalog template with the specified name.
`java.util.Collection<java.lang.String>`	`getCatalogTemplateNames()` Returns a collection of all catalog template names available.
`java.util.Collection<Query>`	`getCategoryQueries()` Returns a collection of all category queries available.
`Query`	`getCategoryQuery(java.lang.String name)` Returns the category query with the specified name.
`java.util.Collection<java.lang.String>`	`getCategoryQueryNames()` Returns a collection of all category query names available.
`CategoryViewSet`	`getCategoryViewSet(java.lang.String name)` Returns the category view set with the specified name.
`java.util.Collection<java.lang.String>`	`getCategoryViewSetNames()` Returns a collection of all category view set names available.
`CollectionSet`	`getCollectionSet(java.lang.String name)` Returns the collection set with the specified name.
`java.util.Collection<java.lang.String>`	`getCollectionSetNames()` Returns a collection of all collection names available.
`java.util.Collection<CollectionSet>`	`getCollectionSets()` Returns all collection sets.
`CropTemplate`	`getCropTemplate(java.lang.String name)` Returns the crop template with the specified name.
`java.util.Collection<java.lang.String>`	`getCropTemplateNames()` Returns a collection of all crop template names available.
`java.util.Collection<CropTemplate>`	`getCropTemplates()` Returns a collection of all crop templates available.
`CumulusApplicationDisplayPrefs`	`getCumulusApplicationDisplayPrefs()` Returns a read-only instance of the Cumulus application display preferences.
`CumulusApplicationGeneralPrefs`	`getCumulusApplicationGeneralPrefs()` Returns a read-only instance of the Cumulus application general preferences.
`CumulusApplicationSearchPrefs`	`getCumulusApplicationSearchPrefs()` Returns a read-only instance of the Cumulus application search preferences.
`CumulusSession`	`getCumulusSession()` Returns the current CumulusSession object.
`java.lang.String`	`getDefaultAssetAction()` Returns the default asset action name.
`java.lang.String`	`getDefaultAssetHandlingSet()` Returns the default asset handling set name.
`java.lang.String`	`getDefaultAssetHandlingSet(java.lang.String catalogName, boolean forCataloging)` Returns the name of the currently chosen Asset Handling Set for the given catalog.
`java.lang.String`	`getDefaultCropTemplate()` Returns the name of the default crop template name.
`java.lang.String`	`getDefaultMetadataTemplate()` Returns the default metadata template name.
`java.lang.String`	`getDefaultPermissionTemplate()` Returns the default permission template name.
`java.lang.String`	`getDefaultPermissionTemplate(java.lang.String catalogName)` Returns the name of the currently chosen Permission Template for the given catalog.
`java.lang.String`	`getDefaultPrintSet()` Returns the name of the default print set name.
`java.lang.String`	`getDefaultRecordViewSet()` Returns the default record view set name.
`MetadataTemplate`	`getMetadataTemplate(java.lang.String name)` Returns the metadata template with the specified name.
`java.util.Collection<java.lang.String>`	`getMetadataTemplateNames()` Returns a collection of all metadata template names available.
`java.util.Collection<MetadataTemplate>`	`getMetadataTemplates()` Returns all available metadata templates.
`JPack`	`getModulePreferences(java.lang.String moduleUID, boolean sharedSettings)` Return the general preferences for the given module.
`PermissionTemplate`	`getPermissionTemplate(java.lang.String name)` Returns the permission template with the specified name.
`java.util.Collection<java.lang.String>`	`getPermissionTemplateNames()` Returns a collection of all permission template names available.
`java.util.Collection<PermissionTemplate>`	`getPermissionTemplates()` Returns all available permission templates.
`java.lang.Object`	`getPreferences(java.lang.String path)` Returns the managing instance for the specified part of the preferences.
`PrintSet`	`getPrintSet(java.lang.String name)` Returns the print set with the specified name.
`java.util.Collection<java.lang.String>`	`getPrintSetNames()` Returns a collection of all print set names available.
`java.util.Collection<PrintSet>`	`getPrintSets()` Returns a collection of all print sets available.
`Query`	`getQuery(java.lang.String name)` Returns the record query with the specified name.
`RecordFilter`	`getRecordFilter(java.lang.String name)` Returns the record filter with the specified name.
`java.util.Collection<java.lang.String>`	`getRecordFilterNames()` Returns a collection of all record filter names available.
`java.util.Collection<Query>`	`getRecordQueries()` Returns a collection of all record queries available.
`Query`	`getRecordQuery(java.lang.String name)` Returns the record query with the specified name.
`java.util.Collection<java.lang.String>`	`getRecordQueryNames()` Returns a collection of all record query names available.
`RecordViewSet`	`getRecordViewSet(java.lang.String name)` Returns the record view set with the specified name.
`java.util.Collection<java.lang.String>`	`getRecordViewSetNames()` Returns a collection of all record view set names available.
`ReportSet`	`getReportSet(java.lang.String name)` Returns the report set with the specified name.
`java.util.Collection<java.lang.String>`	`getReportSetNames()` Returns a collection of all report set names available.
`User`	`getUserSettings()` Returns the user settings for the current user.
`Workspace`	`getWorkspace(java.lang.String name)` Returns the workspace with the specified name.
`java.util.Collection<java.lang.String>`	`getWorkspaceNames()` Returns a collection of all workspaces names available.
`void`	`removePreferencesChangeListener(PreferencesChangeListener preferencesChangeListener, java.lang.String listenerPath)` Removes a listener for preferences changes for the specified path.
`void`	`setModulePreferences(java.lang.String moduleUID, boolean sharedSettings, JPack preferencesPack)` Sets the general preferences for the given module.

- Method Detail
  - getCumulusSession
```
CumulusSession getCumulusSession()
```
    Returns the current CumulusSession object.
    
    Returns:
    The current CumulusSession object.
  - getPreferences
```
java.lang.Object getPreferences(java.lang.String path)
```
    Returns the managing instance for the specified part of the preferences. Please see the package description for more information.
    
    Parameters:
    path - the path to get the preferences for.
    
    Returns:
    the object representing the preferences or null
  - getAssetHandlingSetNames
```
java.util.Collection<java.lang.String> getAssetHandlingSetNames()
```
    Returns a collection of all asset handling set names available.
    
    Returns:
    collection of all asset handling set names available
  - getAssetHandlingSets
```
java.util.Collection<AssetHandlingSet> getAssetHandlingSets()
```
    Returns a collection of all asset handling sets available.
    
    Returns:
    collection of all asset handling sets available
    Since:
    
    8.6
  - getRecordViewSetNames
```
java.util.Collection<java.lang.String> getRecordViewSetNames()
```
    Returns a collection of all record view set names available.
    
    Returns:
    collection of all record view set names available
  - getCategoryViewSetNames
```
java.util.Collection<java.lang.String> getCategoryViewSetNames()
```
    Returns a collection of all category view set names available.
    
    Returns:
    collection of all category view set names available
  - getAssetActionNames
```
java.util.Collection<java.lang.String> getAssetActionNames()
```
    Returns a collection of all asset action names available.
    
    Returns:
    collection of all asset action names available
  - getAssetActions
```
java.util.Collection<AssetAction> getAssetActions()
```
    Returns a collection of all asset actions available.
    
    Returns:
    collection of all asset actions available
    Since:
    
    8.6
  - getMetadataTemplateNames
```
java.util.Collection<java.lang.String> getMetadataTemplateNames()
```
    Returns a collection of all metadata template names available.
    
    Returns:
    collection of all metadata template names available
  - getMetadataTemplates
```
java.util.Collection<MetadataTemplate> getMetadataTemplates()
```
    Returns all available metadata templates.
    
    Returns:
    all available metadata templates
    Since:
    
    8.6
  - getRecordQueryNames
```
java.util.Collection<java.lang.String> getRecordQueryNames()
```
    Returns a collection of all record query names available.
    
    Returns:
    collection of all record query names available
  - getCategoryQueryNames
```
java.util.Collection<java.lang.String> getCategoryQueryNames()
```
    Returns a collection of all category query names available.
    
    Returns:
    collection of all category query names available
  - getDefaultAssetHandlingSet
```
java.lang.String getDefaultAssetHandlingSet()
```
    Returns the default asset handling set name.
    
    Returns:
    default asset handling set name
  - getDefaultRecordViewSet
```
java.lang.String getDefaultRecordViewSet()
```
    Returns the default record view set name.
    
    Returns:
    default record view set name
  - getDefaultAssetAction
```
java.lang.String getDefaultAssetAction()
```
    Returns the default asset action name.
    
    Returns:
    default asset action name
  - getDefaultMetadataTemplate
```
java.lang.String getDefaultMetadataTemplate()
```
    Returns the default metadata template name.
    
    Returns:
    default metadata template name
  - getPrintSetNames
```
java.util.Collection<java.lang.String> getPrintSetNames()
```
    Returns a collection of all print set names available.
    
    Returns:
    collection of all print set names available
    Since:
    
    7.0
  - getPrintSets
```
java.util.Collection<PrintSet> getPrintSets()
```
    Returns a collection of all print sets available.
    
    Returns:
    collection of all print sets available
    Since:
    
    8.6
  - getDefaultPrintSet
```
java.lang.String getDefaultPrintSet()
```
    Returns the name of the default print set name.
    
    Returns:
    default print set name
    Since:
    
    7.0
  - getCropTemplateNames
```
java.util.Collection<java.lang.String> getCropTemplateNames()
```
    Returns a collection of all crop template names available.
    
    Returns:
    collection of all crop template names available
    Since:
    
    11.0.2
  - getCropTemplates
```
java.util.Collection<CropTemplate> getCropTemplates()
```
    Returns a collection of all crop templates available.
    
    Returns:
    collection of all crop templates available
    Since:
    
    11.0.2
  - getDefaultCropTemplate
```
java.lang.String getDefaultCropTemplate()
```
    Returns the name of the default crop template name.
    
    Returns:
    default crop template name
    Since:
    
    11.0.2
  - addPreferencesChangeListener
```
void addPreferencesChangeListener(PreferencesChangeListener preferencesChangeListener,
                                java.lang.String listenerPath)
```
    Add a listener for preferences changes for the specified path. The listener gets a notification for any change in the preferences below the given path.
    
    Parameters:
    preferencesChangeListener - the listener instance to be notified of changes
    listenerPath - the path to listen for changes
    Since:
    
    6.6
  - removePreferencesChangeListener
```
void removePreferencesChangeListener(PreferencesChangeListener preferencesChangeListener,
                                   java.lang.String listenerPath)
```
    Removes a listener for preferences changes for the specified path.
    
    Parameters:
    preferencesChangeListener - the listener instance to remove
    listenerPath - the path the listener to remove for
    Since:
    
    6.6
  - getDefaultAssetHandlingSet
```
java.lang.String getDefaultAssetHandlingSet(java.lang.String catalogName,
                                          boolean forCataloging)
```
    Returns the name of the currently chosen Asset Handling Set for the given catalog. This reads the user settings for the current user.
    
    Parameters:
    catalogName - name of the catalog to find the corresponding asset handling set
    forCataloging - if true the asset handling set for cataloging will be returned otherwise the asset handling set for asset access
    
    Returns:
    name of the corresponding asset handling set
  - getDefaultPermissionTemplate
```
java.lang.String getDefaultPermissionTemplate(java.lang.String catalogName)
```
    Returns the name of the currently chosen Permission Template for the given catalog. This reads the user settings for the current user.
    
    Parameters:
    catalogName - name of the catalog to find the corresponding permission template
    
    Returns:
    name of the corresponding permission template
    Since:
    
    7.5.1
  - getDefaultPermissionTemplate
```
java.lang.String getDefaultPermissionTemplate()
```
    Returns the default permission template name.
    
    Returns:
    default permission template name or null if not found
    Since:
    
    7.5.1
  - getPermissionTemplateNames
```
java.util.Collection<java.lang.String> getPermissionTemplateNames()
```
    Returns a collection of all permission template names available.
    
    Returns:
    collection of all permission template names available
  - getPermissionTemplates
```
java.util.Collection<PermissionTemplate> getPermissionTemplates()
```
    Returns all available permission templates.
    
    Returns:
    all available permission templates
    Since:
    
    8.6
  - getRecordViewSet
```
RecordViewSet getRecordViewSet(java.lang.String name)
```
    Returns the record view set with the specified name.
    
    Parameters:
    name - the name of the set to get
    
    Returns:
    the set instance or null if not found
    Since:
    
    7.0
  - getCategoryViewSet
```
CategoryViewSet getCategoryViewSet(java.lang.String name)
```
    Returns the category view set with the specified name.
    
    Parameters:
    name - the name of the set to get
    
    Returns:
    the set instance or null if not found
    Since:
    
    7.0
  - getCollectionSetNames
```
java.util.Collection<java.lang.String> getCollectionSetNames()
```
    Returns a collection of all collection names available.
    
    Returns:
    collection of all collection names available
    Since:
    
    7.0
  - getCollectionSet
```
CollectionSet getCollectionSet(java.lang.String name)
```
    Returns the collection set with the specified name.
    
    Parameters:
    name - the name of the set to get
    
    Returns:
    the set instance or null if not found
    Since:
    
    7.0
  - getCollectionSets
```
java.util.Collection<CollectionSet> getCollectionSets()
```
    Returns all collection sets.
    
    Returns:
    all set instances or an empty collection if no set could be found
    Since:
    
    8.6.1
  - getRecordFilter
```
RecordFilter getRecordFilter(java.lang.String name)
```
    Returns the record filter with the specified name.
    
    Parameters:
    name - the name of the filter to get
    
    Returns:
    the filter instance or null if not found
    Since:
    
    7.0
  - getRecordFilterNames
```
java.util.Collection<java.lang.String> getRecordFilterNames()
```
    Returns a collection of all record filter names available.
    
    Returns:
    collection of all record filter names available
    Since:
    
    7.0
  - getUserSettings
```
User getUserSettings()
```
    Returns the user settings for the current user.
    
    Returns:
    the current users settings
  - getPermissionTemplate
```
PermissionTemplate getPermissionTemplate(java.lang.String name)
```
    Returns the permission template with the specified name.
    
    Parameters:
    name - the name of the template to get
    
    Returns:
    the template instance or null if not found
    Since:
    
    7.5
  - getQuery
```
Query getQuery(java.lang.String name)
```
    Returns the record query with the specified name.
    
    Parameters:
    name - the name of the record query to get
    
    Returns:
    the record query instance or null if not found
    Since:
    
    7.5
  - getCategoryQuery
```
Query getCategoryQuery(java.lang.String name)
```
    Returns the category query with the specified name.
    
    Parameters:
    name - the name of the category query to get
    
    Returns:
    the category query instance or null if not found
    Since:
    
    7.5
  - getMetadataTemplate
```
MetadataTemplate getMetadataTemplate(java.lang.String name)
```
    Returns the metadata template with the specified name.
    
    Parameters:
    name - the name of the template to get
    
    Returns:
    the template instance or null if not found
    Since:
    
    7.5
  - getPrintSet
```
PrintSet getPrintSet(java.lang.String name)
```
    Returns the print set with the specified name.
    
    Parameters:
    name - the name of the set to get
    
    Returns:
    the set instance or null if not found
    Since:
    
    7.5
  - getCropTemplate
```
CropTemplate getCropTemplate(java.lang.String name)
```
    Returns the crop template with the specified name.
    
    Parameters:
    name - the name of the crop template to get
    
    Returns:
    the crop template instance or null if not found
    Since:
    
    11.0.2
  - getAssetHandlingSet
```
AssetHandlingSet getAssetHandlingSet(java.lang.String name)
```
    Returns the asset handling set with the specified name.
    
    Parameters:
    name - the name of the set to get
    
    Returns:
    the set instance or null if not found
    Since:
    
    7.5
  - getAssetAction
```
AssetAction getAssetAction(java.lang.String name)
```
    Returns the asset action with the specified name.
    
    Parameters:
    name - the name of the action to get
    
    Returns:
    action instance or null if not found
    Since:
    
    7.5.1
  - getRecordQuery
```
Query getRecordQuery(java.lang.String name)
```
    Returns the record query with the specified name.
    
    Parameters:
    name - the name of the query to get
    
    Returns:
    query instance or null if not found
    Since:
    
    7.5.1
  - getRecordQueries
```
java.util.Collection<Query> getRecordQueries()
```
    Returns a collection of all record queries available.
    
    Returns:
    collection of all record queries available
    Since:
    
    8.6
  - getCategoryQueries
```
java.util.Collection<Query> getCategoryQueries()
```
    Returns a collection of all category queries available.
    
    Returns:
    collection of all category queries available
    Since:
    
    8.6
  - getWorkspaceNames
```
java.util.Collection<java.lang.String> getWorkspaceNames()
```
    Returns a collection of all workspaces names available.
    
    Returns:
    collection of all workspaces names available
    Since:
    
    7.5.1
  - getWorkspace
```
Workspace getWorkspace(java.lang.String name)
```
    Returns the workspace with the specified name.
    
    Parameters:
    name - the name of the workspace to get
    
    Returns:
    workspace instance or null if not found
    Since:
    
    7.5.1
  - getReportSetNames
```
java.util.Collection<java.lang.String> getReportSetNames()
```
    Returns a collection of all report set names available.
    
    Returns:
    collection of all report set names available
    Since:
    
    8.0
  - getReportSet
```
ReportSet getReportSet(java.lang.String name)
```
    Returns the report set with the specified name.
    
    Parameters:
    name - the name of the set to get
    
    Returns:
    the set instance or null if not found
    Since:
    
    8.0
  - getCatalogTemplateNames
```
java.util.Collection<java.lang.String> getCatalogTemplateNames()
```
    Returns a collection of all catalog template names available.
    
    Returns:
    collection of all catalog template names available
    Since:
    
    8.6.1
  - getCatalogTemplate
```
CatalogTemplate getCatalogTemplate(java.lang.String name)
```
    Returns the catalog template with the specified name.
    
    Parameters:
    name - the name of the template to get
    
    Returns:
    the template instance or null if not found
    Since:
    
    8.6.1
  - getCumulusApplicationGeneralPrefs
```
CumulusApplicationGeneralPrefs getCumulusApplicationGeneralPrefs()
```
    Returns a read-only instance of the Cumulus application general preferences.
    
    Returns:
    read-only instance of the Cumulus application general preferences
    Since:
    
    8.0
  - getCumulusApplicationDisplayPrefs
```
CumulusApplicationDisplayPrefs getCumulusApplicationDisplayPrefs()
```
    Returns a read-only instance of the Cumulus application display preferences.
    
    Returns:
    read-only instance of the Cumulus application display preferences
    Since:
    
    8.0
  - getCumulusApplicationSearchPrefs
```
CumulusApplicationSearchPrefs getCumulusApplicationSearchPrefs()
```
    Returns a read-only instance of the Cumulus application search preferences.
    
    Returns:
    read-only instance of the Cumulus application search preferences
    Since:
    
    8.0
  - getModulePreferences
```
JPack getModulePreferences(java.lang.String moduleUID,
                         boolean sharedSettings)
```
    Return the general preferences for the given module.
    
    Parameters:
    moduleUID - uid of the module to get the preferences for
    sharedSettings - true for shared settings and false for user settings
    
    Returns:
    existing preferences or empty record pack
    Since:
    
    8.5.2
  - setModulePreferences
```
void setModulePreferences(java.lang.String moduleUID,
                        boolean sharedSettings,
                        JPack preferencesPack)
```
    Sets the general preferences for the given module.
    
    Parameters:
    moduleUID - uid of the module to set the preferences for
    sharedSettings - true for shared settings and false for user settings
    preferencesPack - the preferences to store
    Since:
    
    8.5.2

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 Preferences

Method Summary

Method Detail

getCumulusSession

getPreferences

getAssetHandlingSetNames

getAssetHandlingSets

getRecordViewSetNames

getCategoryViewSetNames

getAssetActionNames

getAssetActions

getMetadataTemplateNames

getMetadataTemplates

getRecordQueryNames

getCategoryQueryNames

getDefaultAssetHandlingSet

getDefaultRecordViewSet

getDefaultAssetAction

getDefaultMetadataTemplate

getPrintSetNames

getPrintSets

getDefaultPrintSet

getCropTemplateNames

getCropTemplates

getDefaultCropTemplate

addPreferencesChangeListener

removePreferencesChangeListener

getDefaultAssetHandlingSet

getDefaultPermissionTemplate

getDefaultPermissionTemplate

getPermissionTemplateNames

getPermissionTemplates

getRecordViewSet

getCategoryViewSet

getCollectionSetNames

getCollectionSet

getCollectionSets

getRecordFilter

getRecordFilterNames

getUserSettings

getPermissionTemplate

getQuery

getCategoryQuery

getMetadataTemplate

getPrintSet

getCropTemplate

getAssetHandlingSet

getAssetAction

getRecordQuery

getRecordQueries

getCategoryQueries

getWorkspaceNames

getWorkspace

getReportSetNames

getReportSet

getCatalogTemplateNames

getCatalogTemplate

getCumulusApplicationGeneralPrefs

getCumulusApplicationDisplayPrefs

getCumulusApplicationSearchPrefs

getModulePreferences

setModulePreferences