Package com.canto.cumulus.prefs

The Cumulus preferences package for accessing the Cumulus preferences.

See: Description

Interface Summary

Interface	Description
BaseManager.PackEntryChangeListener
Item	This interface is the base for set operations.
ItemManager	This manager interface provides set type independent access for set management functions.
MetadataTemplate.ChangeCallback
PackFallback	Implementations of this interface are able to generate a JPack instance.
PackListener	You need to implement a listener of this type to get notified if a preferences pack is about ot be saved.
Preferences	This interfaces describes the methods available when accessing the preferences of Cumulus.
PreferencesChangeListener	This interface describes the callback function for preferences listeners.
PreferencesImpl.ItemIDProvider
Saver	This class saves changes back to the server.
Saver.ChangeListener

Class Summary

Class	Description
AssetAction	This class represents an Asset Action and its settings.
AssetActionPacker	This class manages the settings for a single packer of an AssetAction.
AssetActionPackers	This class manages all packers of an AssetAction.
AssetActionProcessor	This class manages the settings for a single processor of an AssetAction.
AssetActionProcessors	This class manages all processors of an AssetAction.
AssetActionSaver	This class manages the settings for a single saver of an AssetAction.
AssetActionSavers	This class manages all savers of an AssetAction.
AssetActionsList	This class manages a list of asset actions.
AssetFiltersList	This class manages a list of filters in an asset handling set.
AssetFormatsList	This class manages the formats list of an asset handling set.
AssetHandlingSet	This class represents an asset handling set.
AssetHandlingSetList	This class manages a list of asset handling sets.
AssetHandlingSetModuleEntry	This class represents a module reference used by an asset handling set.
AssetHandlingSetWorkflow	This class represents a workflow reference used by an asset handling set.
AssetHandlingSetWorkflowList	This class manages a list of workflows configured for an asset handling set.
AssetModuleList	This class manages a list of modules.
AssetRelation	This class stores the settings for a single asset relation.
AssetRelationList	This class manages a list of asset relations.
BackupJob	This class manages a single backup job and enables one to access the jobs settings and statistics.
BackupJobConfiguration	This class manages the configuration of a single backup job.
BackupJobList	This class manages a list of server backup jobs.
BackupJobStatistics	This class stores the job statistics for a backup job.
BaseManager	This class manages all the base work for preferences access.
BaseManager.RegistryEntry	This class manages a single entry of the tree structure of the cumulus preferences.
BaseQueriesList
CatalogAssetRelationList	This class manages a list of asset relations stored in a catalog.
CatalogField	This class manages the settings of a single record or category field.
CatalogFieldEnumListSort	This class manages the sort settings for a single string enum catalog field.
CatalogFieldEnumListSortOrders	This class manages the sort orders for the different languages for a single string enum catalog field.
CatalogFieldEnumListValueContainer	This class manages the entries for a string enum field.
CatalogFieldEnumListValueContainerCoreValue	This class manages a single value of a string enum field.
CatalogFieldEnumListValueContainerCoreValueList	This class manages a list of string enum values.
CatalogFieldList	This class manages a list of fields.
CatalogFieldValidatorConfiguration	This class manages the configuration of a single validator.
CatalogFieldValidatorConfigurationList	This class manages a list of validator configurations.
CatalogGUIDList	This class manages a list of GUIDs.
CatalogInfo	This class wraps access to some catalog specific statistics.
CatalogLinkedField	This class manages the settings for a single module field linked to a catalog field.
CatalogList	This class manages a list of catalog names.
CatalogSettingsRoot	This class is the entry point for all catalog related settings.
CatalogTemplate	This class manages the settings of a catalog template.
CatalogTemplateLayout	This class manages the settings of a catalog template.
CatalogTemplateList	This class manages a list of catalog templates.
CatalogWorkflowList	This class manages a list of workflows stored in a catalog.
CategoryField	This class manages the category field settings in a category view set.
CategoryFieldList	This class manages a list of category fields.
CategoryQueriesList	This class manages a list of record queries.
CategoryViewSet	This class provides access to all settings of a category view set.
CategoryViewSetList	This class manages a list of category view sets.
CategoryViewSetTable	This class provides access to the list of fields for a category table.
CategoryViewSetTableList	This class manages a list of category view set settings for tables.
CollectionSet	This class manages the settings of a collection set.
CollectionSetList	This class manages a list of collection sets.
CropTemplate	This class manages all the settings of a single crop template.
CropTemplatesList	This class manages a list of crop templates.
CumulusApplicationDisplayPrefs	This helper class gives access to the display settings of the current user for the Cumulus application.
CumulusApplicationGeneralPrefs	This helper class gives access to the general settings of the current user for the Cumulus application.
CumulusApplicationGeneralPrefs.AssetHandlingSetAdvancedEntry	This helper class gives access to the asset handling set configuration for the complex mode for a single entry.
CumulusApplicationGeneralPrefs.AssetHandlingSetsAdvancedSettingsList	This helper class gives access to the asset handling set configuration for the complex mode.
CumulusApplicationSearchPrefs	This helper class gives access to the search settings of the current user for the Cumulus application.
CumulusApplicationSearchPrefs.QuickSeachFieldList
CumulusApplicationSearchPrefs.QuickSearchField
CustomData	This class manages custom data.
CustomDataList	This class manages custom data list entries.
CustomDataListEntry
DBMirroring	This class wraps the mirroring configuration of a single catalog.
EmailClass	This class stores the settings for a single email class.
EmailClassesList	This class manages a list of email classes.
EmailClassPlaceholder	This class stores the settings for a single email class.
EmailClassPlaceholderList	This class manages a list of placeholders for an email class.
EmailClassTemplate	This class stores the settings for a single email template.
EmailClassTemplateList	This class manages a list of templates for an email class.
EmailLayout	This class stores the settings for a single email layout.
EmailLayoutAttachment	This class stores the settings for a single email class.
EmailLayoutAttachmentsList	This class manages a list of attachments for an email layout.
EmailLayoutsList	This layout manages a list of email layouts.
FallbackProvider	This class provides lazy support for pack creation fallbacks.
FieldLinkingList	This class manages a list of module fields linked to a catalog field.
FilterListModuleEntry	This class manages a single filter entry of a AssetFiltersList.
FontDetail	This class encapsulates all style information for a font definition.
FormatListModuleEntry	This class manages a single format entry of an AssetFormatsList.
ListPackFallback	This class provides a PackFallback for list packs.
ListPackManager	This class manages a preferences class containing a list of items.
MetadataTemplate	This class stores the settings for a single metadata template.
MetadataTemplateEntry	This class describes a single entry of a metadata template.
MetadataTemplateEntryList	This class manages a list of metadata template entries.
MetadataTemplatesList	This class manages a list of metadata templates.
MetadataTemplateTable	This class describes a single table of a metadata template.
MetadataTemplateTableList	This class manages a list of tables containing template entries.
ModuleJsonPreferences<T>	This class manages the module preferences of a specific module and updates the cached data if it has been changed.
ModulePreferences	This class manages the preferences of a single module.
ModulePreferencesList	This class stores preferences for modules.
PermissionsListTable
PermissionsListTables
PermissionTemplate	This class stores the settings for a single permission template.
PermissionTemplatesList	This class manages a list of permission templates.
PreferencesImpl	The Preferences object allows you to access the user preferences of Cumulus.
PreferencesImpl.NopPackListener
PreferencesImpl.SaverAdapter
PrintSet	This class manages all the settings of a single print set.
PrintSetAdvanced	This class manages the settings for the advanced print mode of a print set.
PrintSetDocumentBlib	This class either manages a single block of text including layout or provides a list of child blibs using an instance of PrintSetDocumentStore.
PrintSetDocumentStore	This class manages a list of blibs.
PrintSetsList	This class manages a list of print sets.
PrintSetTabSet	This class manages a list of tab stops for a PrintSetDocumentStore.
PrintSetTabStop	This class stores the settings of a single tab stop.
Query	This class stores a single query.
QueryCondition
QueryConditionAssetXRef	Stores the query condition configuration for the fields GUID.UID_REC_RELATED_MASTER_ASSETS and GUID.UID_REC_RELATED_SUB_ASSETS.
QueryConditionBase
QueryConditionBoolean	This class represents a query condition for boolean fields.
QueryConditionCategories	This class represents a query condition for the Categories field.
QueryConditionDataSize	This class represents a query condition for DataSize fields.
QueryConditionDataSizeLong
QueryConditionDate
QueryConditionDateOnly
QueryConditionDouble
QueryConditionInteger
QueryConditionLabel
QueryConditionLengthInInch
QueryConditionList
QueryConditionLong
QueryConditionRating
QueryConditionResolution
QueryConditionString
QueryConditionStringEnum
QueryConditionTimeOnly
QueryConditionVocabulary
RecordField	This class manages the record field settings in a record view.
RecordFieldList	This class manages a list of record fields.
RecordFieldOptions	This class stores the general settings of a record view.
RecordFilter	This class stores the settings for a record filter.
RecordFilterList	This class manages a list of record filters.
RecordPackFallback	This class provides a PackFallback for record packs.
RecordQueriesList	This class manages a list of record queries.
RecordView	This class is the settings starting point for a single record view of a record view set.
RecordViewList	This class manages the list of record views available in a record view set.
RecordViewSet	This class stores the settings for a single record view set.
RecordViewSetList	This class manages a list of record view sets.
RecordViewSetTable	This class stores the settings for a single record view set.
RecordViewSetTableList	This class manages a list of record view set settings for tables.
ReportSet
ReportSetList
RestrictionsList	This class manages a list of roles and user UIDs for editability restrictions.
SchedulerJob	This class manages a single scheduler job and enables one to access the jobs settings and statistics.
SchedulerJobConfiguration	This class manages the configuration of a single scheduler job.
SchedulerJobList	This class manages a list of server scheduler jobs.
SchedulerJobStatistics	This class stores the job statistics for a scheduler job.
ServerRoot	This class enables on to access all Cumulus preferences.
ServerSettings	This class is the main entry point for all shared server settings.
SolrIntegrationConfiguration	This class stores the Solr integration configuration for a single table.
StringSet	This class manages a set of Strings.
TableConfigurations	This class stores the configurations for a single table.
TableConfigurationsList	This class manages a list of table specific configurations.
TableSubscriptionConfiguration	This class stores the subscription configuration for a single table.
TableValidatorConfiguration	This class manages the configuration of a single validator.
TableValidatorConfigurationList	This class manages a list of validator configurations.
User	This class is the entry point for all user dependent settings.
UserList	This class provides access to the user settings of contained users.
UserModuleLRU	This class manages the LRUs for a single module.
UserModuleLRUList	This class manages a list of LRUs for modules.
WeakFieldReference	This class holds information about a single referenced field.
WeakFieldReferenceList	Manages a list of weak field references.
Workflow	This class stores the settings for a single workflow.
WorkflowActivities	This class stores the activities for a single workflow.
WorkflowActivity	This class stores the settings for a single workflow activity.
WorkflowActivityList	This class manages a list of workflow activities.
WorkflowList	This class manages a list of workflows.
WorkflowState	This class stores the settings for a single workflow state.
WorkflowStateList	This class manages a list of workflow states.
WorkflowStates	This class stores the states for a single workflow.
Workspace	This class manages the settings of a workspace.
WorkspaceList	This class manages a list of workspaces.

Enum Summary

Enum	Description
AssetAction.ErrorMode	This enum specifies the different types for the asset action error mode.
AssetAction.ErrorModeFileFormats	This enum specifies the different types of handling assets that do not fit the configured asset type restriction.
CatalogFieldList.FieldListMode
CropTemplate.Constraint	The cropping constraints.
CropTemplate.OutputSizeMode	The cropping output size mode.
CropTemplate.Type	The type of crop template.
EmailClassesList.PredefinedClassID
EmailClassTemplate.LayoutMode
MetadataTemplateEntry.ValueFillMode	Describes the available fill modes for field values.
QueryConditionAssetXRef.MatchMode
QueryConditionBoolean.MatchMode	The available match modes.
QueryConditionCategories.MatchMode	The available match modes for the Categories field.
QueryConditionDataSize.ComparisonMode	The possible comparison modes for the match modes QueryConditionDataSize.MatchMode.MATCHES and QueryConditionDataSize.MatchMode.DOESNT_MATCH.
QueryConditionDataSize.MatchMode	The available match modes.
QueryConditionDataSizeLong.ComparisonMode
QueryConditionDataSizeLong.MatchMode
QueryConditionDate.ComparisonMode
QueryConditionDate.CustomRangeDirection
QueryConditionDate.CustomRangeUnit
QueryConditionDate.MatchMode
QueryConditionDate.StaticRange
QueryConditionDateOnly.ComparisonMode
QueryConditionDateOnly.MatchMode
QueryConditionDouble.ComparisonMode
QueryConditionDouble.MatchMode
QueryConditionInteger.ComparisonMode
QueryConditionInteger.MatchMode
QueryConditionLabel.MatchMode
QueryConditionLengthInInch.ComparisonMode
QueryConditionLengthInInch.MatchMode
QueryConditionLong.ComparisonMode
QueryConditionLong.MatchMode
QueryConditionRating.MatchMode
QueryConditionResolution.ComparisonMode
QueryConditionResolution.MatchMode
QueryConditionString.ComparisonMode
QueryConditionString.MasterComparisonMode
QueryConditionString.MatchMode
QueryConditionStringEnum.MatchMode
QueryConditionTimeOnly.ComparisonMode
QueryConditionTimeOnly.MatchMode
QueryConditionVocabulary.MatchMode
RecordField.Visibility
SetImportDuplicatesMode
WorkflowActivity.AssignmentMode

Package com.canto.cumulus.prefs Description

The Cumulus preferences package for accessing the Cumulus preferences.

Overview

This package provides access to the entire preferences system of Cumulus.
Since version 6.0 Cumulus uses a complex preferences structure to store its settings. The preferences are organized as a hierarchical tree. This preferences tree is accessible through this API. The entry point to the preferences is the Preferences class which has a few convenience methods to access names of Sets used by Cumulus:

        Collection getAssetHandlingSetNames();
        Collection getRecordViewSetNames();
        Collection getCategoryViewSetNames();
        Collection getAssetActionNames ();
        Collection getMetadataTemplateNames ();
        Collection getRecordQueryNames ();
        Collection getCategoryQueryNames ();
    

The most versatile method is: Object getPreferences(String path) As mentioned the Cumulus preferences are organized as a tree. The path parameter specifies the preferences subtree you want to get as the result from the call.
To get all preferences you simply call:

        Application app = Application.getInstance ();
        RecordCollection rc = app.getCurrentRecordCollection ();
        CumulusSession cumulusSession = rc.getCumulusSession ();
        com.canto.cumulus.prefs.Preferences preferences = cumulusSession.getPreferences ();
        ServerRoot completePrefs = (ServerRoot) preferences.getPreferences ("/");
    

In this case the returned object is an instance of the ServerRoot class that provides methods like:

        ServerSettings getServerSettings();
        UserList getUsers();
        String getCurrentActiveUser();
    

Calling getServerSettings() for example returns another object which represents the settings used for the whole server you are connected to through the used CumulusSession object. You can experiment with this knowledge and explore the preferences through the given class structure hiding the underlying complexity.

Path Syntax

A path definition always looks like this /USRS/[UUID]:[userUID]/MoPr/[UID:MTyp]:[SampleEJP:1]/SOpG. The / separates the different preferences layers. As a layer can be a either a record pack or a list pack the access of such a pack differs. For a record pack you can simply use the key of the subpack in the parent pack. In the example above USRS is the key of the Users list pack being used to store the list pack in the ServerRoot instance. As the Users list pack needs some key to find the correct entry in the list of contained child elements a primary key field and value needs to be provided: [UUID]:[userUID] is such a primary key specification with UUID as the primary key field for the wanted value userUID. If the child elements have a primary key consisting of multiple fields the syntax is [UID:MTyp]:[SampleEJP:1]. The individual fields are separated by a :.
A overview of the internal structure and keys for the objects can be found in this document.

© 2002-2021 Canto GmbH. All Rights Reserved.