Cumulus Java Classes 
Reference Documentation  
Version 11.1.7
  
A B C D E F G H I J K L M N O P Q R S T U V W X 

R

RatingFieldData - Class in com.canto.cumulus.db.statistics
This class is the wrapper class for statistics range data of rating fields.
RatingFieldData() - Constructor for class com.canto.cumulus.db.statistics.RatingFieldData
Required to make Externalizable happy.
RatingFieldData(JPack) - Constructor for class com.canto.cumulus.db.statistics.RatingFieldData
 
RatingFieldData(GUID) - Constructor for class com.canto.cumulus.db.statistics.RatingFieldData
 
RatingFieldData(GUID, RatingFieldValue, RatingFieldValue) - Constructor for class com.canto.cumulus.db.statistics.RatingFieldData
 
RatingFieldData(GUID, Locale, RatingFieldValue, RatingFieldValue) - Constructor for class com.canto.cumulus.db.statistics.RatingFieldData
 
RatingFieldValue - Class in com.canto.cumulus.fieldvalue
A field value wrapper for a "Rating" field.
RatingFieldValue(FieldDefinition) - Constructor for class com.canto.cumulus.fieldvalue.RatingFieldValue
Creates a new instance for the given rating field.
read() - Method in class com.canto.cumulus.InputDataStream
Reads the next byte of data from the input stream.
read(byte[], int, int) - Method in class com.canto.cumulus.InputDataStream
Reads up to len bytes of data into an array of bytes from this input stream.
READ_ONLY_BASE_ENUM_ID - Static variable in class com.canto.cumulus.prefs.CatalogFieldEnumListValueContainerCoreValueList
 
READ_ONLY_SERIAL_NUMBER - Static variable in class com.canto.cumulus.Cumulus
The Toolbox Runtime RO serial number to provide for read-only access in the Server.openConnection(boolean, String, String, String) method.
READ_WRITE_SERIAL_NUMBER - Static variable in class com.canto.cumulus.Cumulus
The Toolbox Runtime RW serial number to provide for read-write access in the Server.openConnection(boolean, String, String, String) connectToServer} method.
readAllWhenAdding() - Method in class com.canto.cumulus.FieldListEntry
Returns the "When Adding Assets Read All" state of the field.
readAllWhenUpdating() - Method in class com.canto.cumulus.FieldListEntry
Returns the "When Updating Assets Read All" state of the field.
readExternal(ObjectInput) - Method in class com.canto.cumulus.db.statistics.FieldData
Used for implementing Externalizable.
readExternal(ObjectInput) - Method in class com.canto.cumulus.server.esp.modules.dbmirror.MirroringTask
Needed for the Externalizable implementation.
readExternal(ObjectInput) - Method in class com.canto.cumulus.utils.JPack
 
readID(JPack) - Static method in class com.canto.cumulus.prefs.CatalogFieldEnumListValueContainerCoreValue
 
readJPEGInfoFromAsset(Asset) - Static method in class com.canto.cumulus.Pixmap
Reads the image size and bitdepth if the given asset references an accessible JPEG asset.
readName(JPack) - Static method in class com.canto.cumulus.prefs.CumulusApplicationGeneralPrefs.AssetHandlingSetAdvancedEntry
 
rebuild() - Method in class com.canto.cumulus.Catalog
Repairs the catalog and rebuilds the indices (Administrator only).
rebuild(boolean) - Method in class com.canto.cumulus.Catalog
Rebuilds the catalog.
rebuild(boolean, ProgressListener) - Method in class com.canto.cumulus.Catalog
Rebuilds the catalog.
rebuild(DBRebuild) - Method in interface com.canto.cumulus.server.esp.modules.dbmirror.DBMirrorWorker
Start a rebuild from the mirrored information.
RECORD_FILTER_PARAMS_FIND_ABOVE - Static variable in class com.canto.cumulus.usermanagement.CatalogLiveFilterQuery
 
RECORD_FILTER_PARAMS_FIND_BELOW - Static variable in class com.canto.cumulus.usermanagement.CatalogLiveFilterQuery
 
RECORD_FILTER_PARAMS_FIND_RELATED - Static variable in class com.canto.cumulus.usermanagement.CatalogLiveFilterQuery
 
RECORD_VIEW_TYPE_CALENDAR_PANE - Static variable in class com.canto.cumulus.prefs.RecordView
 
RECORD_VIEW_TYPE_DETAILS - Static variable in class com.canto.cumulus.prefs.RecordView
 
RECORD_VIEW_TYPE_INFO_VIEW - Static variable in class com.canto.cumulus.prefs.RecordView
 
RECORD_VIEW_TYPE_INFO_WIN - Static variable in class com.canto.cumulus.prefs.RecordView
 
RECORD_VIEW_TYPE_PALETTE - Static variable in class com.canto.cumulus.prefs.RecordView
 
RECORD_VIEW_TYPE_PREVIEW_VIEW - Static variable in class com.canto.cumulus.prefs.RecordView
 
RECORD_VIEW_TYPE_PREVIEW_WIN - Static variable in class com.canto.cumulus.prefs.RecordView
 
RECORD_VIEW_TYPE_REPORT - Static variable in class com.canto.cumulus.prefs.RecordView
 
RECORD_VIEW_TYPE_THUMBNAIL - Static variable in class com.canto.cumulus.prefs.RecordView
 
RecordCategoryAddedActionExecutor - Interface in com.canto.cumulus.server.esp.modules.trigger.recordcategoryadded
Interface for executors for record or category addition conditions.
RecordCategoryAddedCondition - Class in com.canto.cumulus.db.trigger
This class represents a condition that fires if a record or category has been created.
RecordCategoryAddedCondition() - Constructor for class com.canto.cumulus.db.trigger.RecordCategoryAddedCondition
RecordCategoryAddedCondition(GUID) - Constructor for class com.canto.cumulus.db.trigger.RecordCategoryAddedCondition
Creates an unbound condition for the given field.
RecordCategoryAddedConditionRuntimeData - Class in com.canto.cumulus.server.esp.modules.trigger.recordcategoryadded
This class provides access to the fired conditions runtime data.
RecordCategoryAddedConditionRuntimeData(JPack) - Constructor for class com.canto.cumulus.server.esp.modules.trigger.recordcategoryadded.RecordCategoryAddedConditionRuntimeData
Creates the runtime data for the given runtime data pack.
RecordCategoryDeletedActionExecutor - Interface in com.canto.cumulus.server.esp.modules.trigger.recordcategorydeleted
Interface for executors for record or category deletion conditions.
RecordCategoryDeletedCondition - Class in com.canto.cumulus.db.trigger
This class represents a condition that fires if a record or category has been deleted.
RecordCategoryDeletedCondition() - Constructor for class com.canto.cumulus.db.trigger.RecordCategoryDeletedCondition
Creates an unbound condition.
RecordCategoryDeletedConditionRuntimeData - Class in com.canto.cumulus.server.esp.modules.trigger.recordcategorydeleted
 
RecordCategoryDeletedConditionRuntimeData(JPack) - Constructor for class com.canto.cumulus.server.esp.modules.trigger.recordcategorydeleted.RecordCategoryDeletedConditionRuntimeData
Creates the runtime data for the given runtime data pack.
RecordData - Class in com.canto.cumulus.db
RecordData(JPack) - Constructor for class com.canto.cumulus.db.RecordData
Wrap the new RecordData object around a package that contains the record's field data.
RecordField - Class in com.canto.cumulus.prefs
This class manages the record field settings in a record view.
RecordField.Visibility - Enum in com.canto.cumulus.prefs
 
RecordFieldList - Class in com.canto.cumulus.prefs
This class manages a list of record fields.
RecordFieldOptions - Class in com.canto.cumulus.prefs
This class stores the general settings of a record view.
RecordFilter - Class in com.canto.cumulus.prefs
This class stores the settings for a record filter.
RecordFilterList - Class in com.canto.cumulus.prefs
This class manages a list of record filters.
RecordIdentifier - Interface in com.canto.cumulus.db
This interface allows to identify a record in a collection.
RecordItem - Class in com.canto.cumulus
This class represents a record in the Cumulus.TABLE_NAME_ASSET_RECORDS table of a Cumulus catalog.
RecordItemCollection - Class in com.canto.cumulus
A collection of RecordItem objects of a Cumulus catalog.
RecordPackFallback - Class in com.canto.cumulus.prefs
This class provides a PackFallback for record packs.
RecordPackFallback() - Constructor for class com.canto.cumulus.prefs.RecordPackFallback
 
RecordPackWrapper - Class in com.canto.cumulus.utils
This class can server as a base class for a pack wrapper helper class for record packs.
RecordQueriesList - Class in com.canto.cumulus.prefs
This class manages a list of record queries.
RecordView - Class in com.canto.cumulus.prefs
This class is the settings starting point for a single record view of a record view set.
RecordViewList - Class in com.canto.cumulus.prefs
This class manages the list of record views available in a record view set.
RecordViewSet - Class in com.canto.cumulus.prefs
This class stores the settings for a single record view set.
RecordViewSetList - Class in com.canto.cumulus.prefs
This class manages a list of record view sets.
RecordViewSetTable - Class in com.canto.cumulus.prefs
This class stores the settings for a single record view set.
RecordViewSetTableList - Class in com.canto.cumulus.prefs
This class manages a list of record view set settings for tables.
redirect(String, GUID) - Method in class com.canto.cumulus.Asset
Redirects the asset content to another existing asset.
reduceBiggerFitHeight() - Method in class com.canto.cumulus.prefs.CumulusApplicationDisplayPrefs
 
reduceBiggerFitHeightPreviewView() - Method in class com.canto.cumulus.prefs.CumulusApplicationDisplayPrefs
 
reduceBiggerFitImage() - Method in class com.canto.cumulus.prefs.CumulusApplicationDisplayPrefs
 
reduceBiggerFitImagePreviewView() - Method in class com.canto.cumulus.prefs.CumulusApplicationDisplayPrefs
 
reduceBiggerFitWidth() - Method in class com.canto.cumulus.prefs.CumulusApplicationDisplayPrefs
 
reduceBiggerFitWidthPreviewView() - Method in class com.canto.cumulus.prefs.CumulusApplicationDisplayPrefs
 
register(GeneralEJP) - Method in interface com.canto.cumulus.modules.ejpregistries.general.GeneralEJPRegistry
Add an EJP to the global registry of general EJPs.
register(ServerConsoleEJP) - Method in interface com.canto.cumulus.modules.ejpregistries.serverconsole.ServerConsoleEJPRegistry
Add an EJP to the global registry of ServerConsole EJPs.
registerAction(ActionESP) - Method in class com.canto.cumulus.server.esp.modules.trigger.ActionRegistry
Registers the given trigger action ESP at this instance.
registerMirror(DBMirrorESP) - Method in class com.canto.cumulus.server.esp.modules.dbmirror.DBMirrorRegistry
Registers the specified mirroring esp.
registerReportGeneratorESP(ReportGeneratorESP) - Method in class com.canto.cumulus.server.esp.modules.reportgenerator.ReportGeneratorRegistry
Registers the given Report Generator ESP.
registerSchedulerESP(SchedulerESP) - Method in class com.canto.cumulus.server.esp.modules.scheduler.SchedulerRegistry
Registers the given scheduler ESP.
registerValidatorESP(ValidatorESP) - Method in class com.canto.cumulus.server.esp.modules.validator.ValidatorRegistry
Registers the given validator.
registerValidatorESP(TableValidatorESP) - Method in class com.canto.cumulus.server.esp.modules.validator.ValidatorRegistry
Registers the given table validator.
RegistryManager - Class in com.canto.cumulus.modules
The global registry of all native and Java modules.
releaseModuleLicense(CumulusSession, int) - Method in class com.canto.cumulus.modules.ModuleRegistry
Release a license previously allocated using the ModuleRegistry.allocateModuleLicense(com.canto.cumulus.CumulusSession, int) method.
reload() - Method in class com.canto.cumulus.keyword.service.AutoTaggingManager.AutoTaggingConfiguration
 
remove(AssetHandlingSetWorkflow) - Method in class com.canto.cumulus.prefs.AssetHandlingSetWorkflowList
Removes the given workflow from this list.
remove(CatalogField) - Method in class com.canto.cumulus.prefs.CatalogFieldList
Removes the given field from this list.
remove(GUID) - Method in class com.canto.cumulus.prefs.CatalogGUIDList
Removes the given GUID from this list.
remove(CategoryField) - Method in class com.canto.cumulus.prefs.CategoryFieldList
Removes the given field from this list.
remove(CumulusApplicationGeneralPrefs.AssetHandlingSetAdvancedEntry) - Method in class com.canto.cumulus.prefs.CumulusApplicationGeneralPrefs.AssetHandlingSetsAdvancedSettingsList
 
remove(CatalogLinkedField) - Method in class com.canto.cumulus.prefs.FieldLinkingList
Removes the given entry from this list.
remove(RecordField) - Method in class com.canto.cumulus.prefs.RecordFieldList
Removes the given field from this list.
remove(String) - Method in class com.canto.cumulus.prefs.StringSet
Removes the given String from this list.
removeAll() - Method in class com.canto.cumulus.prefs.StringSet
Removes all Strings from this list.
removeAllItems() - Method in class com.canto.cumulus.ItemCollection
Make this collection empty.
removeAllItems() - Method in class com.canto.cumulus.MultiItemCollection
Remove all items from this collection making it empty.
removeAllowedMasterCategoryName(String) - Method in class com.canto.cumulus.prefs.CategoryViewSet
Removes a master category name from the list of allowed master categories.
removeAllPackListener() - Method in class com.canto.cumulus.usermanagement.FieldValue
 
removeAllPackListener() - Method in class com.canto.cumulus.usermanagement.FieldValues
 
removeAllPermissions(String) - Method in class com.canto.cumulus.db.permissions.Permissions
Removes all permissions for the specified role or user.
removeAllPermissions(String, boolean) - Method in class com.canto.cumulus.db.permissions.Permissions
Removes all permissions for the specified role or user.
removeAllReferences(GUID) - Method in class com.canto.cumulus.fieldvalue.AssetXRefFieldValue
Remove all reference for a given relation.
removeAllUIDs() - Method in class com.canto.cumulus.prefs.RestrictionsList
Clears this restrictions list.
removeAuthenticatorListener(AuthenticatorListener<AuthenticationManager>) - Method in class com.canto.cumulus.usermanagement.AuthenticationManager
Removes a previously registered listener.
removeButtonAt(int) - Method in class com.canto.cumulus.ui.Toolbar
Removes a button at the specified index.
removeCatalog(String) - Method in class com.canto.cumulus.prefs.CatalogList
Removes the given catalog name from this list.
removeCatalog(int, int, String) - Method in class com.canto.cumulus.Server
Remove a catalog from the Cumulus server.
removeCatalog(int) - Method in class com.canto.cumulus.ui.CollectionWindow
Remove catalog from the collection window.
removeCatalog(String) - Method in class com.canto.cumulus.usermanagement.Role.CatalogNames
Removes the catalog with the specified name from this role.
removeCatalogingListener(CatalogingListener<ItemCollection>) - Method in class com.canto.cumulus.ItemCollection
removeCatalogListener(CatalogListener<Application>) - Method in class com.canto.cumulus.ui.Application
removeCatalogProperties(CatalogPropertiesListener<Catalog>) - Method in class com.canto.cumulus.Catalog
removeCatalogTrigger(Catalog, Trigger) - Method in class com.canto.cumulus.db.trigger.TriggerManager
Removes the given trigger as a catalog trigger.
removeCategoriesTrigger(Catalog, Trigger) - Method in class com.canto.cumulus.db.trigger.TriggerManager
Removes the given trigger as a trigger for all categories of the specified catalog.
removeChangeListener(BaseManager.PackEntryChangeListener) - Method in class com.canto.cumulus.prefs.BaseManager
 
removeChangeListener(int, BaseManager.PackEntryChangeListener) - Method in class com.canto.cumulus.prefs.BaseManager
 
removeChangeListener(Saver.ChangeListener) - Method in class com.canto.cumulus.prefs.PreferencesImpl.SaverAdapter
 
removeChangeListener(Saver.ChangeListener) - Method in interface com.canto.cumulus.prefs.Saver
 
removeCollectionListener(CollectionListener<ItemCollection>) - Method in class com.canto.cumulus.ItemCollection
removeCollectionListener(CollectionListener<MultiItemCollection>) - Method in class com.canto.cumulus.MultiItemCollection
removeCollectionWindowListener(CollectionWindowListener<Application>) - Method in class com.canto.cumulus.ui.Application
removeContextMenuListener(ContextMenuListener<Application>) - Method in class com.canto.cumulus.ui.Application
removeEntity(String) - Method in class com.canto.cumulus.usermanagement.EntityRestrictor
Removes access to the specified entity for the entire server.
removeEntity(String, String) - Method in class com.canto.cumulus.usermanagement.EntityRestrictor
Removes access to the specified entity for the specified catalog.
removeField(GUID) - Method in class com.canto.cumulus.keyword.service.AutoTaggingManager.AutoTaggingConfiguration
 
removeField(CumulusApplicationSearchPrefs.QuickSearchField) - Method in class com.canto.cumulus.prefs.CumulusApplicationSearchPrefs.QuickSeachFieldList
 
removeField(String) - Method in class com.canto.cumulus.prefs.CumulusApplicationSearchPrefs.QuickSeachFieldList
 
removeField(WeakFieldReference) - Method in class com.canto.cumulus.prefs.WeakFieldReferenceList
Removes the given field from this list.
removeFilter(String) - Method in class com.canto.cumulus.ItemCollection
Remove a user live filter that was added using ItemCollection.addFilter(String, String, java.util.Locale).
removeFilter(String) - Method in class com.canto.cumulus.MultiItemCollection
removeGlobalCatalogingListener(CatalogingListener<ItemCollection>) - Static method in class com.canto.cumulus.ItemCollection
removeGlobalCatalogPropertiesListener(CatalogPropertiesListener<Catalog>) - Static method in class com.canto.cumulus.Catalog
removeGlobalChangeListener(Saver.ChangeListener) - Method in class com.canto.cumulus.prefs.BaseManager
 
removeGlobalCollectionListener(CollectionListener<ItemCollection>) - Static method in class com.canto.cumulus.ItemCollection
removeGlobalCollectionListener(CollectionListener<MultiItemCollection>) - Static method in class com.canto.cumulus.MultiItemCollection
removeID(int) - Method in class com.canto.cumulus.fieldvalue.CategoriesFieldValue
Remove one category assignment.
removeIDs(Set<Integer>) - Method in class com.canto.cumulus.fieldvalue.CategoriesFieldValue
Remove some category assignments.
removeInitializationListener(JPack.InitializationListener) - Method in class com.canto.cumulus.utils.JPack
 
removeItem(int, int) - Method in class com.canto.cumulus.MultiItemCollection
Remove an item from this collection.
removeItem(ItemIdentifier) - Method in class com.canto.cumulus.MultiItemCollection
Remove an item from this collection.
removeItemCollection(int) - Method in class com.canto.cumulus.MultiItemCollection
Remove the ItemCollection of the given catalog from this collection.
removeItems(Collection<ItemIdentifier>) - Method in class com.canto.cumulus.MultiItemCollection
Remove a whole list of items from this collection.
removeItemsByID(Collection<Integer>) - Method in class com.canto.cumulus.ItemCollection
Remove a whole list of items from this collection.
removeItemTrigger(Item, Trigger) - Method in class com.canto.cumulus.db.trigger.TriggerManager
Removes the given trigger as a trigger for the specified record.
removeMasterImage(String) - Method in class com.canto.cumulus.mediadeliverycloud.MediaDeliveryCloudManager
Deletes the master image and the renditions at the media delivery cloud.
removeMasterImage(String, boolean) - Method in class com.canto.cumulus.mediadeliverycloud.MediaDeliveryCloudManager
Deletes the master image and the renditions at the media delivery cloud and invalidates the corresponding entries in the CDN.
removeMenu(Menu) - Method in class com.canto.cumulus.ui.MenuBar
Removes a menu from the menu bar.
removeMenuAt(int) - Method in class com.canto.cumulus.ui.MenuBar
Removes a menu by index.
removeMenuByID(int) - Method in class com.canto.cumulus.ui.MenuBar
Removes a menu by ID.
removeMenuItem(MenuItem) - Method in class com.canto.cumulus.ui.Menu
Removes a menu item.
removeMenuItemAt(int) - Method in class com.canto.cumulus.ui.Menu
Removes a menu item by index.
removeMenuItemByID(int) - Method in class com.canto.cumulus.ui.Menu
Removes a menu item by ID.
removeMultipleLanguagesLanguage(int) - Method in class com.canto.cumulus.prefs.CatalogField
Removes the specified language from the multiple languages field bundle.
removeOriginalAsset(String) - Method in class com.canto.cumulus.mediadeliverycloud.MediaDeliveryCloudManager
Deletes the original asset at the media delivery cloud.
removeOriginalAsset(String, boolean) - Method in class com.canto.cumulus.mediadeliverycloud.MediaDeliveryCloudManager
Deletes the original asset at the media delivery cloud.
removePackListener(PackListener) - Method in class com.canto.cumulus.prefs.BaseManager
Removes listener previously registered with BaseManager.addPackListener(PackListener).
removePermission(String, String) - Method in class com.canto.cumulus.db.permissions.Permissions
Removes the specified permission for the specified role or user.
removePermission(String, String, boolean) - Method in class com.canto.cumulus.db.permissions.Permissions
Removes the specified permission for the specified role or user.
removePermission(String, String, boolean) - Method in class com.canto.cumulus.db.permissions.PermissionsList
Removes the specified permission for the specified role or user for all entities.
removePermission(String, String) - Method in class com.canto.cumulus.prefs.PermissionsListTable
Removes the specified positive permission for the specified user or role.
removePermission(String, String) - Method in class com.canto.cumulus.prefs.PermissionTemplate
Removes the specified positive permission for the specified user or role.
removePermission(String) - Method in class com.canto.cumulus.usermanagement.RolePermissions
Removes the specified permissions from all objects.
removePermission(String, String) - Method in class com.canto.cumulus.usermanagement.RolePermissions
Removes a permission from the specified catalog object.
removePermissionRemoval(String, String) - Method in class com.canto.cumulus.prefs.PermissionsListTable
Removes the specified negative permission for the specified user or role.
removePermissionRemoval(String, String) - Method in class com.canto.cumulus.prefs.PermissionTemplate
Removes the specified negative permission for the specified user or role.
removePreferencesChangeListener(PreferencesChangeListener, String) - Method in interface com.canto.cumulus.prefs.Preferences
Removes a listener for preferences changes for the specified path.
removePreferencesChangeListener(PreferencesChangeListener, String) - Method in class com.canto.cumulus.prefs.PreferencesImpl
 
removeProduct(Product) - Method in class com.canto.cumulus.usermanagement.ProductList
Removes the specified product from this list.
removeRecordsTrigger(Catalog, Trigger) - Method in class com.canto.cumulus.db.trigger.TriggerManager
Removes the given trigger as a trigger for all records of the specified catalog.
removeReference(GUID, int) - Method in class com.canto.cumulus.fieldvalue.AssetXRefFieldValue
Remove the reference to another item.
removeRestrictedType(GUID) - Method in class com.canto.cumulus.prefs.RecordFilter
Removes the given type from the list of restricted types.
removeRole(String) - Method in class com.canto.cumulus.usermanagement.User
Removes a role from the roles assigned to this user.
removeRole(String) - Method in class com.canto.cumulus.usermanagement.User.RoleNames
Removes a role from the list of roles this user is assigned to.
removeSelectionListener(SelectionListener<Application>) - Method in class com.canto.cumulus.ui.Application
removeServerPermission(String) - Method in class com.canto.cumulus.usermanagement.ServerPermissions
Removes the specified server permission from the role.
removeServerTrigger(Trigger) - Method in class com.canto.cumulus.db.trigger.TriggerManager
Removes the given trigger as a server trigger.
removeStartStopListener(StartStopListener) - Static method in class com.canto.cumulus.Cumulus
Removes a StartStopListener from the Cumulus environment.
removeSubDepartment(AuthenticationManager.Department) - Method in class com.canto.cumulus.usermanagement.AuthenticationManager.Department
Remove the given child department.
removeSubscription(Item) - Method in class com.canto.cumulus.db.subscriptions.SubscriptionManager
Unsubscribe from the given item.
removeUID(String) - Method in class com.canto.cumulus.prefs.RestrictionsList
Removes a user or role UID from this list.
removeUser(String) - Method in class com.canto.cumulus.usermanagement.Role.UserNames
Removes the specified user from this role.
removeUserOrRole(String) - Method in class com.canto.cumulus.prefs.PermissionsListTable
Removes the user or role including all assigned permissions.
removeUserOrRole(String) - Method in class com.canto.cumulus.prefs.PermissionTemplate
Removes the user or role including all assigned permissions.
removeVideo(Item) - Method in class com.canto.cumulus.video.cloud.VideoCloudManager
Deletes the video at the video cloud provider along with all of its variants.
removeVideo(String) - Method in class com.canto.cumulus.video.cloud.VideoCloudManager
Deletes the video at the video cloud provider along with all of its variants.
removeWatermarkImage(String) - Method in class com.canto.cumulus.mediadeliverycloud.MediaDeliveryCloudManager
Deletes the watermark image at the media delivery cloud.
rename(String) - Method in class com.canto.cumulus.Asset
Renames the name of the asset to the new name.
rename(String, boolean) - Method in class com.canto.cumulus.Asset
Renames the name of the asset to the new name.
rename(String, AssetAction) - Method in class com.canto.cumulus.prefs.AssetActionsList
Renames the given asset action to the new specified name.
rename(String, AssetAction, boolean, boolean) - Method in class com.canto.cumulus.prefs.AssetActionsList
Renames the given asset action to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.AssetActionsList
Renames the given item to the new UID.
rename(String, AssetHandlingSet) - Method in class com.canto.cumulus.prefs.AssetHandlingSetList
Renames the given asset handling set to the new specified name.
rename(String, AssetHandlingSet, boolean, boolean) - Method in class com.canto.cumulus.prefs.AssetHandlingSetList
Renames the given asset handling set to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.AssetHandlingSetList
Renames the given item to the new UID.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.AssetRelationList
 
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.BaseQueriesList
Renames the given item to the new UID.
rename(String, CatalogTemplate) - Method in class com.canto.cumulus.prefs.CatalogTemplateList
Renames the given catalog template to the new specified name.
rename(String, CatalogTemplate, boolean, boolean) - Method in class com.canto.cumulus.prefs.CatalogTemplateList
Renames the given catalog template to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.CatalogTemplateList
 
rename(String, CategoryViewSet) - Method in class com.canto.cumulus.prefs.CategoryViewSetList
Renames the given category view set to the new specified name.
rename(String, CategoryViewSet, boolean, boolean) - Method in class com.canto.cumulus.prefs.CategoryViewSetList
Renames the given category view set to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.CategoryViewSetList
Renames the given item to the new UID.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.CollectionSetList
Renames the given item to the new UID.
rename(String, CropTemplate) - Method in class com.canto.cumulus.prefs.CropTemplatesList
Renames the given crop template to the new specified name.
rename(String, CropTemplate, boolean, boolean) - Method in class com.canto.cumulus.prefs.CropTemplatesList
Renames the given crop template to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.CropTemplatesList
 
rename(String, EmailClass) - Method in class com.canto.cumulus.prefs.EmailClassesList
Renames the given email class to the new specified name.
rename(String, EmailClass, boolean, boolean) - Method in class com.canto.cumulus.prefs.EmailClassesList
Renames the given email class to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.EmailClassesList
Renames the given item to the new UID.
rename(String, EmailClassPlaceholder) - Method in class com.canto.cumulus.prefs.EmailClassPlaceholderList
Renames the given placeholder to the new specified name.
rename(String, EmailClassTemplate) - Method in class com.canto.cumulus.prefs.EmailClassTemplateList
Renames the given template to the new specified name.
rename(String, EmailLayout) - Method in class com.canto.cumulus.prefs.EmailLayoutsList
Renames the given email layout to the new specified name.
rename(String, EmailLayout, boolean, boolean) - Method in class com.canto.cumulus.prefs.EmailLayoutsList
Renames the given email layout to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.EmailLayoutsList
Renames the given item to the new UID.
rename(String, Item, boolean, boolean) - Method in interface com.canto.cumulus.prefs.ItemManager
Renames the given item to the new UID.
rename(String, MetadataTemplate) - Method in class com.canto.cumulus.prefs.MetadataTemplatesList
Renames the given metadata template to the new specified name.
rename(String, MetadataTemplate, boolean, boolean) - Method in class com.canto.cumulus.prefs.MetadataTemplatesList
Renames the given metadata template to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.MetadataTemplatesList
Renames the given item to the new UID.
rename(String, PermissionTemplate) - Method in class com.canto.cumulus.prefs.PermissionTemplatesList
Renames the given permission template to the new specified name.
rename(String, PermissionTemplate, boolean, boolean) - Method in class com.canto.cumulus.prefs.PermissionTemplatesList
Renames the given permission template to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.PermissionTemplatesList
Renames the given item to the new UID.
rename(String, PrintSet) - Method in class com.canto.cumulus.prefs.PrintSetsList
Renames the given print set to the new specified name.
rename(String, PrintSet, boolean, boolean) - Method in class com.canto.cumulus.prefs.PrintSetsList
Renames the given print set to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.PrintSetsList
 
rename(String, RecordFilter) - Method in class com.canto.cumulus.prefs.RecordFilterList
Renames the given record filter to the new specified name.
rename(String, RecordFilter, boolean, boolean) - Method in class com.canto.cumulus.prefs.RecordFilterList
Renames the given record filter to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.RecordFilterList
 
rename(String, RecordViewSet) - Method in class com.canto.cumulus.prefs.RecordViewSetList
Renames the given record view set to the new specified name.
rename(String, RecordViewSet, boolean, boolean) - Method in class com.canto.cumulus.prefs.RecordViewSetList
Renames the given record view set to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.RecordViewSetList
Renames the given item to the new UID.
rename(String, Workflow) - Method in class com.canto.cumulus.prefs.WorkflowList
Renames the given workflow to the new specified name.
rename(String, Workflow, boolean, boolean) - Method in class com.canto.cumulus.prefs.WorkflowList
Renames the given workflow to the new specified name.
rename(String, Item, boolean, boolean) - Method in class com.canto.cumulus.prefs.WorkflowList
Renames the given item to the new UID.
renameAsset(String, boolean) - Method in class com.canto.cumulus.Item
Rename the asset referenced by this item.
renameOpenCatalogClientGroup(String, String) - Method in class com.canto.cumulus.usermanagement.AuthenticationManager
Renames the group to the specified new name.
renameRole(String, String) - Method in class com.canto.cumulus.usermanagement.AuthenticationManager
Renames a role.
RENDITION_FORMAT_GIF - Static variable in class com.canto.cumulus.mediadeliverycloud.MediaDeliveryCloudManager
 
RENDITION_FORMAT_JPEG - Static variable in class com.canto.cumulus.mediadeliverycloud.MediaDeliveryCloudManager
 
RENDITION_FORMAT_PNG - Static variable in class com.canto.cumulus.mediadeliverycloud.MediaDeliveryCloudManager
 
RENDITION_FORMAT_TIF - Static variable in class com.canto.cumulus.mediadeliverycloud.MediaDeliveryCloudManager
 
RenditionParameters - Class in com.canto.cumulus.mediadeliverycloud
Parameters for a rendition that can be accessed via the Media Delivery Cloud.
RenditionParameters() - Constructor for class com.canto.cumulus.mediadeliverycloud.RenditionParameters
 
ReportGeneratorConfigurator - Interface in com.canto.cumulus.server.esp.modules.reportgenerator
 
ReportGeneratorConfiguratorWeb - Interface in com.canto.cumulus.server.esp.modules.reportgenerator
This interface allows the creation of a configuration panel available in the Web Server Console.
ReportGeneratorESP - Interface in com.canto.cumulus.server.esp.modules.reportgenerator
 
ReportGeneratorESP.ParameterKey - Enum in com.canto.cumulus.server.esp.modules.reportgenerator
 
ReportGeneratorRegistry - Class in com.canto.cumulus.server.esp.modules.reportgenerator
This class implements the server-side Report Generator registry where Report Generator ESPs are managed.
ReportGeneratorWebESP - Interface in com.canto.cumulus.server.esp.modules.reportgenerator
Interface exposing a method to create a Web configurator
ReportSet - Class in com.canto.cumulus.prefs
 
ReportSetList - Class in com.canto.cumulus.prefs
 
requestGarbageCollection() - Static method in class com.canto.cumulus.Cumulus
Request a memory optimization (garbage collection).
requestPublishing(Item) - Method in class com.canto.cumulus.video.cloud.VideoCloudManager
Request a publishing of the video asset in it's video cloud provider.
requestRemoving(Item) - Method in class com.canto.cumulus.video.cloud.VideoCloudManager
Request to remove the video asset from it's video cloud provider.
requestUnpublishing(Item) - Method in class com.canto.cumulus.video.cloud.VideoCloudManager
Request to unpublish the video asset in it's video cloud provider.
requestUpload(Item) - Method in class com.canto.cumulus.video.cloud.VideoCloudManager
Request an upload of the video asset to the given provider.
resetWorkflow(RecordItem, GUID, int) - Method in class com.canto.cumulus.utils.WorkflowManager
Resets a workflow on the given record.
ResolutionFieldData - Class in com.canto.cumulus.db.statistics
This class is the wrapper class for statistics range data of resolution fields.
ResolutionFieldData() - Constructor for class com.canto.cumulus.db.statistics.ResolutionFieldData
Required to make Externalizable happy.
ResolutionFieldData(JPack) - Constructor for class com.canto.cumulus.db.statistics.ResolutionFieldData
 
ResolutionFieldData(GUID) - Constructor for class com.canto.cumulus.db.statistics.ResolutionFieldData
 
ResolutionFieldData(GUID, ResolutionFieldValue, ResolutionFieldValue) - Constructor for class com.canto.cumulus.db.statistics.ResolutionFieldData
 
ResolutionFieldData(GUID, Locale, ResolutionFieldValue, ResolutionFieldValue) - Constructor for class com.canto.cumulus.db.statistics.ResolutionFieldData
 
ResolutionFieldValue - Class in com.canto.cumulus.fieldvalue
A field value wrapper for a "Resolution" field.
ResolutionFieldValue() - Constructor for class com.canto.cumulus.fieldvalue.ResolutionFieldValue
Create a new empty resolution field value.
ResolutionFieldValue(int) - Constructor for class com.canto.cumulus.fieldvalue.ResolutionFieldValue
Create a new empty resolution field value.
ResolutionFieldValue(double) - Constructor for class com.canto.cumulus.fieldvalue.ResolutionFieldValue
Create a new resolution field value from the given core field value.
ResolutionFieldValue(double, int) - Constructor for class com.canto.cumulus.fieldvalue.ResolutionFieldValue
Create a new resolution field value from the given core field value.
RESOLVE_OR_IGNORE_OPTION_IGNORE - Static variable in class com.canto.cumulus.prefs.AssetHandlingSet
 
RESOLVE_OR_IGNORE_OPTION_RESOLVE - Static variable in class com.canto.cumulus.prefs.AssetHandlingSet
 
resolveAssetReferenceData(CumulusSession, byte[], boolean, Asset) - Method in interface com.canto.cumulus.modules.AssetStorageModule
Returns the asset found for the given asset reference data.
RESTRICTION_MODE_OPTION_ALL_TYPES - Static variable in class com.canto.cumulus.prefs.RecordFilter
 
RESTRICTION_MODE_OPTION_EXCLUDE - Static variable in class com.canto.cumulus.prefs.RecordFilter
 
RESTRICTION_MODE_OPTION_INCLUDE - Static variable in class com.canto.cumulus.prefs.RecordFilter
 
RestrictionsList - Class in com.canto.cumulus.prefs
This class manages a list of roles and user UIDs for editability restrictions.
restrictItemsToCatalog(Collection<T>, MultiItemCollection, PreferencesImpl.ItemIDProvider) - Static method in class com.canto.cumulus.prefs.PreferencesImpl
 
ResultData2D - Interface in com.canto.cumulus.server.esp.modules.reportgenerator
The interface required to be implemented by a report result generated by a report generator plugin.
ResultData2D.ResultData2DRow - Interface in com.canto.cumulus.server.esp.modules.reportgenerator
Interface of a 2D result table row.
ResultDataItemList - Interface in com.canto.cumulus.server.esp.modules.reportgenerator
The interface to be implemented by an item-based report result generated by a report generator plugin.
ResultDataTimeSeries - Interface in com.canto.cumulus.server.esp.modules.reportgenerator
The interface to be implemented by a time-based report result generated by a report generator plugin.
ResultDataTimeSeries.Unit - Enum in com.canto.cumulus.server.esp.modules.reportgenerator
The time unit that defines the length of the time interval for each row of the table.
resultsInNewCollection() - Method in class com.canto.cumulus.prefs.Query
Returns true if the search result should be shown in a new collection.
reverseSortDirection() - Method in class com.canto.cumulus.SortFieldDescriptor
Calling this method reverses the sort direction.
RGBColor - Static variable in class com.canto.cumulus.Pixmap
Value of the color mode for color images.
Role - Class in com.canto.cumulus.db.permissions
This class wraps the information for a single role.
Role - Class in com.canto.cumulus.usermanagement
Instances of this class represent a single role.
Role.CatalogNames - Class in com.canto.cumulus.usermanagement
Manages the catalogs assigned to this role.
Role.UserNames - Class in com.canto.cumulus.usermanagement
Manages the users assigned to this role.
roleAdded(RoleEvent<_Source>) - Method in interface com.canto.cumulus.usermanagement.event.AuthenticatorListener
A role has been added.
roleDeleted(RoleEvent<_Source>) - Method in interface com.canto.cumulus.usermanagement.event.AuthenticatorListener
A role has been deleted.
RoleEvent<_Source> - Class in com.canto.cumulus.usermanagement.event
 
RoleEvent(BaseUserManagementEventObject.EventType, String) - Constructor for class com.canto.cumulus.usermanagement.event.RoleEvent
 
RoleEvent(String, String) - Constructor for class com.canto.cumulus.usermanagement.event.RoleEvent
 
RolePermissions - Class in com.canto.cumulus.usermanagement
This class manages permissions for catalogs.
roleRenamed(RoleEvent<_Source>) - Method in interface com.canto.cumulus.usermanagement.event.AuthenticatorListener
A role has was renamed.
Roles - Class in com.canto.cumulus.db.permissions
This class manages a list of roles.
roleUpdated(RoleEvent<_Source>) - Method in interface com.canto.cumulus.usermanagement.event.AuthenticatorListener
A role has been updated.
rollback(int) - Method in class com.canto.cumulus.Item
Revert this item's asset to an older version.
rotate(int) - Method in class com.canto.cumulus.Pixmap
Rotate the pixmap by a multiple of 90 degrees.
rotate(ImagingPixmap.RotateAngle) - Method in class com.canto.cumulus.utils.ImagingPixmap
Rotates the pixmap.
rotateJpeg(InputDataStream, OutputDataStream, int, int) - Static method in class com.canto.cumulus.Pixmap
Rotates a JPEG image by multiples of 90 degrees clockwise.
A B C D E F G H I J K L M N O P Q R S T U V W X 
Cumulus Java Classes 
Reference Documentation  
Version 11.1.7
  

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.