| Package | Description |
|---|---|
| com.canto.cumulus |
The base package of the Cumulus Java Classes.
|
| com.canto.cumulus.db.dbmirror | |
| com.canto.cumulus.db.mail | |
| com.canto.cumulus.db.permissions | |
| com.canto.cumulus.db.subscriptions | |
| com.canto.cumulus.db.trigger | |
| com.canto.cumulus.fieldvalue |
Wrapper clsses for field values of the Cumulus Java Classes.
|
| com.canto.cumulus.prefs |
The Cumulus preferences package for accessing the Cumulus preferences.
|
| com.canto.cumulus.ui |
The Cumulus application user interface classes.
|
| com.canto.cumulus.usermanagement |
The Cumulus User Management package.
|
| Modifier and Type | Method and Description |
|---|---|
int |
Server.addExistingCatalog(GUID selector,
java.lang.String dbSpec)
Add an existing catalog to the Cumulus server.
|
void |
MultiItemCollection.addFilter(java.lang.String filterID,
java.util.List<? extends FieldData> dataList)
Add a user live filter to this collection.
|
void |
MultiItemCollection.addFilter(java.lang.String filterID,
java.util.List<? extends FieldData> dataList,
boolean doesNotMatch)
Add a user live filter to this collection.
|
void |
MultiItemCollection.addFilter(java.lang.String filterID,
QueryConditionBase queryConditionBase,
java.util.Locale locale,
FieldDefinition fieldDefinition)
Add a user live filter to this collection.
|
void |
MultiItemCollection.addFilter(java.lang.String filterID,
java.lang.String query,
java.util.EnumSet<FindFlag> flags,
java.util.Locale locale)
Add a user live filter to this collection.
|
void |
ItemCollection.addFilter(java.lang.String filterID,
java.lang.String query,
java.util.EnumSet<FindFlag> flags,
java.util.Locale locale)
Add a user live filter to this collection.
|
void |
MultiItemCollection.addFilter(java.lang.String filterID,
java.lang.String query,
java.util.Locale locale)
Add a user live filter to this collection.
|
void |
ItemCollection.addFilter(java.lang.String filterID,
java.lang.String query,
java.util.Locale locale)
Add a user live filter to this collection.
|
int |
Server.addNewCatalog(GUID selector,
java.lang.String dbSpec)
Create a new catalog and add it to the Cumulus server.
|
int |
Server.addNewCatalog(GUID selector,
java.lang.String dbSpec,
java.lang.String catalogTemplate)
Create a new catalog from the given template and add it to the Cumulus server.
|
void |
Item.applyPermissionTemplate(java.lang.String permissionTemplateID)
Sets the permissions stored in the permission template.
|
void |
Catalog.backup(java.lang.String pathName)
Stores a backup copy of the catalog in the given file (Specific Permissions Required).
|
void |
Catalog.backup(java.lang.String pathName,
ProgressListener progressListener)
Stores a backup copy of the catalog in the given file (Specific Permissions Required).
|
void |
ItemCollection.catalogAsset(Asset asset,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
java.util.EnumSet<CatalogingFlag> catalogingFlags,
CatalogingListener<ItemCollection> catalogingListener)
Catalog a single asset to this collection.
|
void |
ItemCollection.catalogAsset(Asset asset,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
java.util.EnumSet<CatalogingFlag> catalogingFlags,
Item additionalFieldValuesItem,
java.util.Map<GUID,MetadataTemplateEntry.ValueFillMode> additionalFieldValuesFillMode,
CatalogingListener<ItemCollection> catalogingListener)
Catalog a single asset to this collection.
|
void |
ItemCollection.catalogAsset(Asset asset,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
java.util.EnumSet<CatalogingFlag> catalogingFlags,
java.util.Set<java.lang.Integer> assignCategoryIDs,
CatalogingListener<ItemCollection> catalogingListener)
Catalog a single asset to this collection.
|
void |
ItemCollection.catalogAssets(AssetCollection assetCollection,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
java.util.EnumSet<CatalogingFlag> catalogingFlags,
CatalogingListener<ItemCollection> catalogingListener)
Catalog a collection of assets to this collection.
|
void |
ItemCollection.catalogAssets(AssetCollection assetCollection,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
java.util.EnumSet<CatalogingFlag> catalogingFlags,
Item additionalFieldValuesItem,
java.util.Map<GUID,MetadataTemplateEntry.ValueFillMode> additionalFieldValuesFillMode,
CatalogingListener<ItemCollection> catalogingListener)
Catalog a collection of assets to this collection.
|
void |
ItemCollection.catalogAssets(AssetCollection assetCollection,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
java.util.EnumSet<CatalogingFlag> catalogingFlags,
java.util.Set<java.lang.Integer> assignCategoryIDs,
CatalogingListener<ItemCollection> catalogingListener)
Catalog a collection of assets to this collection.
|
void |
Server.changePassword(java.lang.String oldPassword,
java.lang.String newPassword)
Changes the current user password.
|
static void |
Server.changePassword(java.lang.String server,
java.lang.String user,
java.lang.String oldPassword,
java.lang.String newPassword)
Changes a user password.
|
java.util.Set<java.lang.Integer> |
Item.checkin(java.lang.String assetHandlingSet,
Asset assetLocal,
java.lang.String comment,
boolean keepCheckedOut,
boolean keepLocalAsset,
boolean removeDeletedSubAssetItems)
Check in a new version of the asset of this item from the given local asset.
|
java.util.Set<java.lang.Integer> |
Item.checkin(java.lang.String assetHandlingSet,
java.lang.String comment,
boolean keepCheckedOut,
boolean keepLocalAsset,
boolean removeDeletedSubAssetItems)
Check in a new version of the asset of this item from the checkout location store din this item.
|
Asset |
Item.checkout(Asset checkoutLocation)
Check out the asset referenced by this item (Specific Permissions Required).
|
void |
Item.clearModifiedValue(GUID fieldUID)
Clear the changed value of the given field in this item reverting to the previous value.
|
void |
Item.clearValue(GUID fieldUID)
Clear the value of the given field in this item.
|
void |
Catalog.compress()
Compresses the catalog (Administrator only).
|
void |
Catalog.compress(ProgressListener progressListener)
Compresses the catalog (Administrator only).
|
Asset |
Asset.convert(Asset destinationContainer,
java.lang.String parameters,
GUID guid)
Converts the asset content and creates a new asset in a container asset.
|
java.io.File |
Asset.convert(java.io.File dstFolder,
java.lang.String params,
GUID guid)
Converts the asset content and creates a new file.
|
Asset |
Item.convertAsset(Asset destinationContainer,
GUID converterModuleUID,
java.lang.String converterParams)
Convert the asset of this item using a given asset processor module and parameter string.
|
java.util.List<Asset> |
Item.copyAsset(Asset destinationContainer)
Copy the asset of this item to a different location.
|
void |
Asset.copyFrom(Asset srcAsset)
Overwrites this asset with the given asset.
|
CategoryItem |
CategoryItem.createCategoryItem(java.lang.String name)
Create a sub-category for this category item with a given name.
|
CategoryItem |
CategoryItem.createCategoryItems(java.lang.String categoryTreePath)
Create category items along the given path and return the bottom-most category item.
|
CategoryItem |
CategoryItem.createDirectoryCategoryItem(int volID,
int dirID,
java.lang.String name)
Create a new category item that represents a Mac OS directory on disk.
|
static Pixmap |
Pixmap.createFromAsset(Asset asset,
java.lang.String assetHandlingSet)
Creates a pixel preview for the given asset.
|
static Pixmap |
Pixmap.createFromAsset(Asset asset,
java.lang.String assetHandlingSet,
int maxSize,
int rotation)
Creates a pixel preview for the given asset.
|
static Pixmap |
Pixmap.createFromAsset(Asset asset,
java.lang.String assetHandlingSet,
int maxSizeWidth,
int maxSizeHeight,
int rotation)
Creates a pixel preview for the given asset.
|
Item |
RecordItemCollection.createItem()
Create a new RecordItem object.
|
Item |
ItemCollection.createItem()
Create a new item object.
|
Item |
RecordItemCollection.createItem(java.lang.String permissionTemplate)
Create a new RecordItem object.
|
Item |
ItemCollection.createItem(java.lang.String permissionTemplate)
Create a new item object.
|
CategoryItem |
CategoryItem.createPathDirectoryCategoryItem(java.lang.String path,
java.lang.String name)
Create a new category item that represents a Windows directory on disk.
|
RecordItem |
RecordItemCollection.createRecordItem()
Create a new RecordItem object.
|
RecordItem |
RecordItemCollection.createRecordItem(java.lang.String permissionTemplate)
Create a new RecordItem object.
|
CategoryItem |
CategoryItem.createRelatedCategoryItem(CategoryItem original,
java.lang.String name)
Create a related category item for the given original category.
|
Asset |
Asset.createSubAsset(Asset srcAsset)
Creates a sub-asset (for example a file in a folder) from the given asset.
|
Asset |
Asset.createSubAsset(java.lang.String sName,
java.lang.String sFileNameExtension,
java.lang.String sMacFileType,
java.lang.String sMacFileCreator,
java.util.Date creationDate,
java.util.Date modificationDate,
java.io.InputStream dataFork,
java.io.InputStream rsrcFork)
Create an asset (e.g.
|
Asset |
Asset.createSubContainerAsset(java.lang.String name,
java.util.Date creationDate,
java.util.Date modificationDate)
Create a container asset (e.g.
|
CategoryItem |
CategoryItem.createURLDirectoryCategoryItem(java.lang.String URL,
java.lang.String name)
Create a new category item that represents a URL or Unix directory on disk.
|
void |
Asset.deleteAsset()
Deletes the asset itself.
|
void |
Item.deleteItem()
Delete this item in the catalog.
|
void |
CategoryItem.deleteItem()
delete this category item from the catalog.
|
void |
Item.deleteItem(boolean deleteAsset)
Delete this item and optionally also the asset that is referenced by this item.
|
void |
Item.deleteItem(boolean deleteAsset,
boolean deleteContainedItems)
Delete this item and optionally all contained items and optionally also the asset that is referenced by this item.
|
AssetCollection |
Item.doAssetAction(Asset destinationAssetContainer,
java.lang.String assetAction)
Perform an asset action on the asset of this item.
|
AssetCollection |
Item.doAssetAction(Asset destinationAssetContainer,
java.lang.String assetAction,
boolean returnCreatedAssets)
Perform an asset action on the asset of this item.
|
AssetCollection |
Item.doAssetAction(Asset destinationAssetContainer,
java.lang.String assetAction,
boolean returnCreatedAssets,
java.util.Map<GUID,JPack> customParameters)
Perform an asset action on the asset of this item.
|
AssetCollection |
MultiItemCollection.doAssetAction(java.lang.String assetAction,
Asset destinationAssetContainer)
Perform an asset action on the assets of the items of this collection.
|
AssetCollection |
MultiItemCollection.doAssetAction(java.lang.String assetAction,
Asset destinationAssetContainer,
boolean returnCreatedAssets)
Perform an asset action on the assets of the items of this collection.
|
AssetCollection |
MultiItemCollection.doAssetAction(java.lang.String assetAction,
Asset destinationAssetContainer,
boolean returnCreatedAssets,
java.util.Map<ItemIdentifier,java.util.Map<GUID,JPack>> customParameters)
Perform an asset action on the assets of the items of this collection.
|
void |
MultiRecordItemCollection.find(java.util.Map<java.lang.Integer,java.util.Set<java.lang.Integer>> categoryIDs,
java.util.EnumSet<FindFlag> flags,
CombineMode combine)
Find record items using the categories assigned to them.
|
void |
MultiRecordItemCollection.find(java.util.Map<java.lang.Integer,java.util.Set<java.lang.Integer>> categoryIDs,
java.util.EnumSet<FindFlag> flags,
CombineMode combine,
boolean logSearchStatistic)
Find record items using the categories assigned to them.
|
int |
RecordItemCollection.find(java.util.Set<java.lang.Integer> categoryIDs,
java.util.EnumSet<FindFlag> flags,
CombineMode combine)
Find record items using assigned categories.
|
int |
RecordItemCollection.find(java.util.Set<java.lang.Integer> categoryIDs,
java.util.EnumSet<FindFlag> flags,
CombineMode combine,
boolean logSearchStatistic)
Find record items using assigned categories.
|
void |
ItemCollection.find(java.lang.String query,
java.util.EnumSet<FindFlag> flags,
CombineMode combine,
java.util.Locale locale)
Performs a search for items.
|
void |
ItemCollection.find(java.lang.String query,
java.util.EnumSet<FindFlag> flags,
CombineMode combine,
java.util.Locale locale,
boolean logSearchStatistic)
Performs a search for items.
|
void |
MultiItemCollection.find(java.lang.String sourceTableName,
java.util.List<ItemIdentifier> sourceItemIDs,
java.lang.String filterName)
Find items in the collection that are the result of applying a record filter to the given items of the given table.
|
void |
MultiItemCollection.find(java.lang.String sourceTableName,
java.util.List<ItemIdentifier> sourceItemIDs,
java.lang.String filterName,
boolean logSearchStatistic)
Find items in the collection that are the result of applying a record filter to the given items of the given table.
|
int |
Server.findCatalogID(JPack catalogReference)
Fidn a catalog at the server by providing the catalog reference data and return the catalog ID.
|
int |
Server.findCatalogID(java.lang.String catalogName)
Find a catalog by name at the server.
|
java.awt.image.BufferedImage |
Pixmap.getAsImage(CumulusSession session,
Item item,
boolean extendImageAreaToBoundingBox,
int maxSizeWidth,
int maxSizeHeight,
int rotation)
Return AWT image which optionally embeds the assets metadata tags.
|
byte[] |
Pixmap.getAsJPEG()
Returns the pixels as JPEG compressed data.
|
byte[] |
Pixmap.getAsJPEG(CumulusSession session,
int maxSize,
int rotation,
int quality) |
byte[] |
Pixmap.getAsJPEG(int maxSize)
Returns the pixels as JPEG compressed data.
|
byte[] |
Pixmap.getAsJPEG(int maxSize,
int rotation,
int quality)
Returns the pixels as JPEG compressed data.
|
byte[] |
Pixmap.getAsJPEG(Item item,
CumulusSession cumulusSession,
int maxWidth,
int maxHeight,
int rotation,
int quality)
Return JPEG image which optionally embeds the assets metadata tags.
|
byte[] |
Pixmap.getAsJPEG(Item item,
int maxSize,
int rotation,
int quality)
Return JPEG image which optionally embeds the assets metadata tags.
|
byte[] |
Pixmap.getAsPNG(int maxSize,
int rotation)
Returns the pixels as PNG compressed data.
|
byte[] |
Pixmap.getAsPNG(int maxSizeWidth,
int maxSizeHeight,
int rotation)
Returns the pixels as PNG compressed data.
|
static Pixmap.AssetInfo |
Pixmap.getAssetInfo(Asset asset)
Reads the image size and bitdepth if the given asset uses a supported format.
|
AssetReference |
Item.getAssetReferenceValue(GUID fieldUID)
Return the asset reference value for the given field.
|
AssetXRefFieldValue |
Item.getAssetXRefValue(GUID fieldUID)
Return the asset reference value for the given field.
|
byte[] |
Audio.getAudio()
Returns the compressed audio data.
|
byte[] |
Item.getBinaryValue(GUID fieldUID)
Return the binary value for the given field.
|
int |
Pixmap.getBitsPerPixel()
Returns the number of bits per pixel.
|
int |
Audio.getBitsPerSample()
Returns the number of bits per sample.
|
boolean |
Item.getBooleanValue(GUID fieldUID)
Return the boolean value for the given field.
|
java.lang.String |
Server.getCatalogDescription(int catalogID,
int languageID)
Return the user readable description for the given catalog.
|
java.lang.String |
Server.getCatalogDisplayName(int catalogID,
int languageID)
Return the user readable display name for the given catalog.
|
Server.CatalogInfo |
Server.getCatalogInfo(int catalogID)
Get Information about a given catalog at the server.
|
Server.CatalogInfo |
Server.getCatalogInfo(int catalogID,
int languageID)
Get Information about a given catalog at the server.
|
CategoriesFieldValue |
RecordItem.getCategoriesValue()
Get the value of the field "Categories" which stores the IDs of the categories that this record item is assigned to.
|
CategoryItem |
CategoryItemCollection.getCategoryItemByID(int categoryID)
Return a CategoryItem specified by ID.
|
CategoryItem |
MultiCategoryItemCollection.getCategoryItemByID(int catalogID,
int categoryID)
Return a category item specified by catalog ID and item ID.
|
CategoryItem |
MultiCategoryItemCollection.getCategoryItemByID(ItemIdentifier identifier)
Return a category item specified by identifier.
|
CategoryItemCollection |
MultiCategoryItemCollection.getCategoryItemCollection(int catalogID)
Return the contained CategoryItemCollection for the given catalog ID.
|
java.lang.String |
Catalog.getCentralAssetLocationXML()
Returns the central asset location reference as XML.
|
int |
Pixmap.getColorMode()
Returns the color mode.
|
int |
Pixmap.getCompressMethod()
Returns the compression method.
|
int |
Audio.getCompressor()
Returns the compression mode.
|
Asset |
Asset.getContainer()
Returns the asset's container asset.
|
int[] |
MultiItemCollection.getDailyStatistics(GUID fieldUID,
java.util.Date startDate,
int numberOfDays)
Get statistics on how many items have date field values that fall into days of the range specified.
|
int[] |
MultiItemCollection.getDailyStatistics(GUID fieldUID,
DateOnlyFieldValue startDate,
int numberOfDays)
Get statistics on how many items have DateOnly field values that fall into days of the range specified.
|
byte[] |
Pixmap.getData()
Returns the compressed pixel data.
|
DataSizeFieldValue |
Item.getDataSizeValue(GUID fieldUID)
Return the data size value for the given field.
|
DateOnlyFieldValue |
Item.getDateOnlyValue(GUID fieldUID)
Return the date only value for the given field.
|
java.util.Date |
Item.getDateValue(GUID fieldUID)
Return the date value for the given field.
|
double |
Item.getDoubleValue(GUID fieldUID)
Return the double value for the given field.
|
int |
Audio.getDuration()
Returns the sound duration in milliseconds.
|
java.lang.String |
Asset.getFilePath()
Get the path for this asset.
|
int |
Pixmap.getHeight()
Returns the height of the image.
|
Asset |
Asset.getHostAsset()
Returns the host asset for this contained asset.
|
int |
Item.getIntValue(GUID fieldUID)
Return the integer value for the given field.
|
Item |
RecordItemCollection.getItemByID(int itemID)
Return a RecordItem specified by ID.
|
Item |
ItemCollection.getItemByID(int itemID)
Return an item specified by ID.
|
Item |
MultiItemCollection.getItemByID(int catalogID,
int itemID)
Return an item specified by catalog ID and item ID.
|
Item |
MultiItemCollection.getItemByID(ItemIdentifier itemIdentifier)
Return an item specified by identifier.
|
int |
ItemCollection.getItemPosition(int itemID)
Return the zero-based index of the given item inside this collection.
|
LabelFieldValue |
Item.getLabelValue(GUID fieldUID)
Return the label value for the given field.
|
Layout |
Catalog.getLayout(java.lang.String tableName)
Get the layout for a given table.
|
LengthInInchFieldValue |
Item.getLengthInInchValue(GUID fieldUID)
Return the length value for the given field.
|
long |
Item.getLongValue(GUID fieldUID)
Return the long value for the given field.
|
int |
Audio.getNbChannel()
Returns the number of channels.
|
CategoryItem |
CategoryItem.getOriginalCategory()
Return the category item representing the original category for this related category.
|
Pixmap |
Item.getPictureValue(GUID fieldUID)
Returns the pixmap instance for the specified field of type
FieldTypes.FieldTypePicture. |
int |
Pixmap.getQuality()
Returns the image quality of the picture.
|
int |
Audio.getRate()
Returns the sample rate.
|
RatingFieldValue |
Item.getRatingValue(GUID fieldUID)
Return the rating value for the given field.
|
RecordItem |
RecordItemCollection.getRecordItemByID(int recordID)
Return a RecordItem specified by ID.
|
RecordItem |
MultiRecordItemCollection.getRecordItemByID(int catalogID,
int recordID)
Return a record item specified by catalog ID and item ID.
|
RecordItem |
MultiRecordItemCollection.getRecordItemByID(ItemIdentifier itemIdentifier)
Return a record item specified by identifier.
|
RecordItemCollection |
MultiRecordItemCollection.getRecordItemCollection(int catalogID)
Return the contained RecordItemCollection for the given catalog ID.
|
ResolutionFieldValue |
Item.getResolutionValue(GUID fieldUID)
Return the resolution value for the given field.
|
StringEnumFieldValue |
Item.getStringEnumValue(GUID fieldUID)
Return the string list value for the given field.
|
java.lang.String |
Item.getStringValue(GUID fieldUID)
Return the string value for the given field.
|
java.lang.String |
Item.getStringValue(GUID fieldUID,
int preferredLanguageID)
Return the string value for the given field.
|
Asset |
Asset.getSubAsset(java.lang.String name)
Returns a sub-asset by name.
|
ItemCollection |
Item.getTableValue(GUID fieldUID)
Get the contents of a field of type "Table" which is an ItemCollection that contains all items of the sub-table belonging to this item.
|
TimeOnlyFieldValue |
Item.getTimeOnlyValue(GUID fieldUID)
Return the time only value for the given field.
|
UserUIDFieldValue |
Item.getUserUIDValue(GUID fieldUID)
Return the user unique ID value for the given field.
|
VocabularyFieldValue |
Item.getVocabularyValue(GUID fieldUID)
Return the vocabulary value for the given field.
|
int |
Pixmap.getWidth()
Returns the width of the image.
|
java.util.Set<java.lang.Integer> |
ItemCollection.matchIDs(java.lang.String query,
java.util.EnumSet<FindFlag> flags,
java.util.Locale locale,
java.util.Set<java.lang.Integer> itemIDs)
Filter the given item IDs and return only those matching a given query.
|
java.util.Set<ItemIdentifier> |
MultiItemCollection.matchIDs(java.lang.String query,
java.util.EnumSet<FindFlag> flags,
java.util.Locale locale,
java.util.Set<ItemIdentifier> itemIDs)
Filter the given item IDs and return only those matching a given query.
|
void |
Catalog.migrate()
Migrates the catalog to the latest catalog format.
|
static void |
Catalog.migrate(java.io.File srcCatalogFile,
java.io.File migratedCatalogFile)
Migrated the given local catalog file to the latest version.
|
static void |
Catalog.migrate(java.io.File srcCatalogFile,
java.io.File migratedCatalogFile,
ProgressListener progressListener)
Migrated the given local catalog file to the latest version.
|
void |
Catalog.migrate(ProgressListener progressListener)
Migrates the catalog to the latest catalog format.
|
java.util.List<Asset> |
Item.moveAsset(Asset destinationContainer)
Move the asset of this item to a different location.
|
CategoryItemCollection |
Catalog.newCategoryItemCollection(java.lang.String masterCategory)
Create a new
CategoryItemCollection and containing all categories of the given master category that are accessible to the current user. |
CategoryItemCollection |
Catalog.newCategoryItemCollection(java.lang.String masterCategory,
java.lang.String query,
java.util.Locale locale)
Create a new
CategoryItemCollection and containing all categories of the given master category that match a given query and are accessible to the
current user. |
ItemCollection |
Catalog.newItemCollection(java.lang.String tableName,
boolean findAllItems)
Create a new
ItemCollection for the given table and optionally fill in all items that are accessible to the current user. |
ItemCollection |
Catalog.newItemCollection(java.lang.String tableName,
java.lang.String query,
java.util.EnumSet<FindFlag> flags,
java.util.Locale locale)
Returns a newly created collection that is filled by executing the given query.
|
MultiItemCollection |
Server.newMultiItemCollection(java.lang.String tableName)
Create a new
MultiItemCollection for the given table. |
RecordItemCollection |
Catalog.newRecordItemCollection(java.lang.String query,
java.util.Locale locale)
Create a new
RecordItemCollection and fill it with the record items found by the given query. |
ItemCollection |
Server.newStatisticsItemCollection(java.lang.String query,
java.util.Locale locale)
Create a new
ItemCollection and fill it with the items found by the given query. |
static Server |
Server.openConnection(boolean bWriteAccess,
java.lang.String server,
java.lang.String user,
java.lang.String password)
Connects to a Cumulus server using the default licensing.
|
static Server |
Server.openConnection(java.lang.String sSerialNumber,
boolean bWriteAccess,
java.lang.String server,
java.lang.String user,
java.lang.String password)
Connects to a Cumulus server using a custom serial number.
|
static Server |
Server.openConnectionAs(boolean bWriteAccess,
java.lang.String server,
java.lang.String userToRunAs,
java.lang.String user,
java.lang.String password)
Connects to a Cumulus server using the default licensing and allows to take the identity of another user.
|
static Server |
Server.openConnectionAs(java.lang.String sSerialNumber,
boolean bWriteAccess,
java.lang.String server,
java.lang.String userToRunAs,
java.lang.String user,
java.lang.String password)
Connects to a Cumulus server using a custom serial number taking identity of a specified user.
|
MultiRecordItemCollection |
Server.openMultiRecordItemCollection(java.lang.String collectionSetName)
Open a server-side collection into a newly created
MultiRecordItemCollection. |
static Pixmap.JPEGInfo |
Pixmap.readJPEGInfoFromAsset(Asset asset)
Reads the image size and bitdepth if the given asset references an accessible JPEG asset.
|
void |
Catalog.rebuild()
Repairs the catalog and rebuilds the indices (Administrator only).
|
void |
Catalog.rebuild(boolean useMirroringConfiguration)
Rebuilds the catalog.
|
void |
Catalog.rebuild(boolean useMirroringConfiguration,
ProgressListener progressListener)
Rebuilds the catalog.
|
Asset |
Asset.redirect(java.lang.String parameters,
GUID guid)
Redirects the asset content to another existing asset.
|
void |
Server.removeCatalog(int catalogID,
int timeout,
java.lang.String message)
Remove a catalog from the Cumulus server.
|
void |
Asset.rename(java.lang.String newName)
Renames the name of the asset to the new name.
|
void |
Asset.rename(java.lang.String newName,
boolean addNumberIfExists)
Renames the name of the asset to the new name.
|
java.lang.String |
Item.renameAsset(java.lang.String newName,
boolean addNumberIfFileExists)
Rename the asset referenced by this item.
|
void |
Item.rollback(int toVersion)
Revert this item's asset to an older version.
|
static void |
Pixmap.rotateJpeg(InputDataStream inStream,
OutputDataStream outStream,
int rotation,
int quality)
Rotates a JPEG image by multiples of 90 degrees clockwise.
|
void |
Item.save()
Save this item back to the catalog.
|
void |
Item.save(java.lang.String assetHandlingSet)
Save this item back to the catalog.
|
JPack |
MultiRecordItemCollection.save(java.lang.String collectionSetName,
boolean sharedSet,
CollectionType type)
Save the contents of this collection at the Cumulus server.
|
JPack |
MultiRecordItemCollection.save(java.lang.String collectionSetName,
CollectionType type,
java.util.Date expirationDate)
Save the contents of this collection as a shared collection at the Cumulus server.
|
byte[] |
Catalog.sendMessage(java.lang.String module,
byte[] inData)
Sends a message with parameters to a server plug-in module.
|
java.lang.String |
Catalog.sendMessage(java.lang.String module,
java.lang.String msg)
Sends a message to a server plug-in module (Administrator only).
|
java.lang.String |
Catalog.sendMessage(java.lang.String module,
java.lang.String msg,
java.lang.String params)
Sends a message with parameters to a server plug-in module (Administrator only).
|
byte[] |
Server.sendServerModuleMessage(java.lang.String module,
byte[] inData)
Sends a message with parameters to a server plug-in module (Administrator only).
|
void |
Item.setAssetReferenceValue(GUID fieldUID,
AssetReference assetReference)
Modify the value of a asset reference field in this item.
|
void |
Item.setAssetXRefValue(GUID fieldUID,
AssetXRefFieldValue assetXRefValue)
Modify the value of a asset cross references field in this item.
|
void |
Item.setBinaryValue(GUID fieldUID,
byte[] value)
Modify the value of a binary, asset reference, asset cross references, picture, or audio field in this item.
|
void |
Item.setBooleanValue(GUID fieldUID,
boolean value)
Modify the value of a boolean field in this item.
|
void |
RecordItem.setCategoriesValue(CategoriesFieldValue categoriesValue)
Modify the category assignment of this record item.
|
void |
Item.setDataSizeValue(GUID fieldUID,
DataSizeFieldValue dataSizeFieldValue)
Modify the value of a data size field in this item.
|
void |
Item.setDateOnlyValue(GUID fieldUID,
DateOnlyFieldValue dateOnlyFieldValue)
Modify the value of a date only field in this item.
|
void |
Item.setDateValue(GUID fieldUID,
java.util.Date date)
Modify the value of a date field in this item.
|
void |
Item.setDoubleValue(GUID fieldUID,
double value)
Modify the value of a double field in this item.
|
void |
Item.setIntValue(GUID fieldUID,
int value)
Modify the value of a integer field in this item.
|
void |
Item.setLabelValue(GUID fieldUID,
LabelFieldValue labelFieldValue)
Modify the value of a label field in this item.
|
void |
Item.setLengthInInchValue(GUID fieldUID,
LengthInInchFieldValue lengthInInchFieldValue)
Modify the value of a length field in this item.
|
void |
Item.setLongValue(GUID fieldUID,
long value)
Modify the value of a long field in this item.
|
void |
MultiItemCollection.setMultiSorting(java.util.List<SortFieldDescriptor> sortFields)
Sort this collection by the given list of fields and sorting directions.
|
void |
ItemCollection.setMultiSorting(java.util.List<SortFieldDescriptor> sortFields)
Sort this collection by the given list of fields and sorting directions.
|
void |
Item.setPictureValue(GUID fieldUID,
Pixmap pixmap)
Modify the value of a picture field in this item.
|
void |
Item.setRatingValue(GUID fieldUID,
RatingFieldValue ratingFieldValue)
Modify the value of a rating field in this item.
|
void |
Item.setResolutionValue(GUID fieldUID,
ResolutionFieldValue resolutionFieldValue)
Modify the value of a resolution field in this item.
|
void |
Server.setSharing(int catalogID,
boolean shared,
boolean publishedToInternet)
Enable or disable sharing this catalog to other users.
|
void |
MultiItemCollection.setSorting(GUID fieldUID)
Sort this collection by a given field.
|
void |
ItemCollection.setSorting(GUID fieldUID)
Sort this collection by a given field.
|
void |
Item.setStringEnumValue(GUID fieldUID,
StringEnumFieldValue stringEnumFieldValue)
Modify the value of a string list field in this item.
|
void |
Item.setStringValue(GUID fieldUID,
java.lang.String value)
Modify the value of a string field in this item.
|
void |
Item.setTimeOnlyValue(GUID fieldUID,
TimeOnlyFieldValue timeOnlyFieldValue)
Modify the value of a time only field in this item.
|
void |
Item.setVocabularyValue(GUID fieldUID,
VocabularyFieldValue vocabularyFieldValue)
Modify the value of a vocabulary field in this item.
|
void |
Item.undoCheckout(boolean keepLocalAsset)
Reverts a previously done "check in" operation (Specific Permissions Required).
|
java.util.Set<java.lang.Integer> |
Item.update(java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
boolean always,
boolean includingSubAssets,
boolean removeDeletedSubAssetItems,
CatalogingListener<ItemCollection> catalogingListener)
Update this item according to changes made to the referenced asset.
|
java.util.Set<java.lang.Integer> |
Item.update(java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
boolean always,
boolean includingSubAssets,
boolean removeDeletedSubAssetItems,
java.util.Set<GUID> fieldsToUpdate,
CatalogingListener<ItemCollection> catalogingListener)
Update this item according to changes made to the referenced asset.
|
void |
Item.updateAsset(java.lang.String assetHandlingSet,
java.util.Set<GUID> fieldsToUpdate)
Update this item's asset with the current metadata of the item.
|
void |
Item.updateAssetReference()
Update the asset reference to the asset for this item using the default asset handling set for this user.
|
void |
Item.updateAssetReference(java.lang.String assetHandlingSet)
Update the asset reference to the asset for this item.
|
java.util.Set<java.lang.Integer> |
ItemCollection.updateItems(java.util.Set<java.lang.Integer> itemIDs,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
boolean always,
boolean includingSubAssets,
boolean removeDeletedSubAssetItems,
CatalogingListener<ItemCollection> catalogingListener)
Update a set of items in the collection according to changes made to their referenced asset.
|
java.util.Set<java.lang.Integer> |
ItemCollection.updateItems(java.util.Set<java.lang.Integer> itemIDs,
java.lang.String assetHandlingSet,
java.lang.String permissionTemplate,
boolean always,
boolean includingSubAssets,
boolean removeDeletedSubAssetItems,
java.util.Set<GUID> fieldsToUpdate,
CatalogingListener<ItemCollection> catalogingListener)
Update a set of items in the collection according to changes made to their referenced asset.
|
| Modifier and Type | Method and Description |
|---|---|
DBMirrorESP |
DBMirrorManager.getMirrorESP(GUID guid)
Returns the mirroring module for the given GUID.
|
MirroringInfo |
DBMirrorManager.getMirroringInfo(GUID catalogUID)
Returns the mirroring process information.
|
GUID[] |
DBMirrorManager.getMirrorsAvailable()
Returns an array of GUIDs for all mirroring modules currently available at the server.
|
| Modifier and Type | Method and Description |
|---|---|
MailServerConfigurations |
MailManager.getMailServerConfigurations()
Returns all mail server configurations.
|
void |
MailManager.sendMessage(java.lang.String from,
java.lang.String recipients,
java.lang.String ccRecipients,
java.lang.String bccRecipients,
java.lang.String subject,
java.lang.String bodyText,
java.util.Collection<Asset> assetsToAttach)
Sends a message.
|
void |
MailManager.sendNotificationMessage(MailServerConfiguration.NotificationsLevel level,
java.lang.String message)
Sends a notification message to the administrator of the cumulus server.
|
java.util.List<MailAddress> |
MailManager.validateAddresses(java.lang.String addresses)
Converts the email addresses in the given string into a list of parsed email addresses.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PermissionManager.applyPermissionTemplate(CategoryItem categoryItem,
PermissionTemplate permissionTemplate)
Applies the given permission template on to the given category.
|
void |
PermissionManager.applyPermissionTemplate(Item item,
PermissionTemplate permissionTemplate)
Applies the given permission template on to the given record.
|
Permissions |
PermissionManager.getPermissions(Item item)
Returns the permissions for the given record item.
|
PermissionsList |
PermissionManager.getPermissionsList(Item item)
Returns a permissions list containing only the permissions for the specified record item.
|
PermissionsList |
PermissionManager.getPermissionsList(ItemCollection itemCollection,
java.util.Set<ItemIdentifier> idList)
Returns a permissions list for a number of records.
|
PermissionsList |
PermissionManager.getPermissionsList(MultiItemCollection multiItemCollection,
java.util.Set<ItemIdentifier> idList)
Returns a permissions list for a number of records.
|
PermissionsList |
PermissionManager.getPermissionsList(java.lang.String tableName,
java.util.Set<ItemIdentifier> idList)
Returns a permissions list for a number of records.
|
Roles |
PermissionManager.getRoles()
Returns the list of roles available at the server.
|
User |
PermissionManager.getUserByLoginName(java.lang.String loginName)
Returns a user by his login name.
|
Users |
PermissionManager.getUsers(java.lang.String match)
Returns a list of users that match the given query string.
|
Users |
PermissionManager.getUsers(java.lang.String match,
boolean activeUsersOnly)
Returns a list of users that match the given query string.
|
void |
PermissionsList.save()
Saves all changes made.
|
void |
Permissions.save()
Saves the current state of permissions for the entity.
|
| Modifier and Type | Method and Description |
|---|---|
void |
SubscriptionManager.addSubscription(Item item)
Subscribe to the given item.
|
java.util.Set<java.lang.String> |
SubscriptionManager.getSubscriptions(Item item)
Returns all user UIDs subscribed to the given item.
|
void |
SubscriptionManager.getUserSubscriptions(ItemCollection itemCollection)
Replaces the content of the given collection with the items the current user is subscribed to.
|
void |
SubscriptionManager.getUserSubscriptions(MultiItemCollection multiItemCollection)
Replaces the content of the given collection with the items the current user is subscribed to.
|
boolean |
SubscriptionManager.hasSubscription(Item item)
Returns whether the current user has a subscription for the given item.
|
void |
SubscriptionManager.removeSubscription(Item item)
Unsubscribe from the given item.
|
boolean |
SubscriptionManager.supportsSubscriptions(Item item)
Returns whether the current item supports subscriptions.
|
| Modifier and Type | Method and Description |
|---|---|
void |
TriggerManager.addCatalogTrigger(Catalog catalog,
Trigger trigger)
Adds the given trigger as a catalog trigger.
|
void |
TriggerManager.addCategoriesTrigger(Catalog catalog,
Trigger trigger)
Adds the given trigger as a trigger for all categories of the specified catalog.
|
void |
TriggerManager.addItemTrigger(Item item,
Trigger trigger)
Adds the given trigger as a trigger for the specified item.
|
void |
TriggerManager.addRecordsTrigger(Catalog catalog,
Trigger trigger)
Adds the given trigger as a trigger for all records of the specified catalog.
|
void |
TriggerManager.addServerTrigger(Trigger trigger)
Adds the given trigger as a server trigger.
|
ActionESP |
TriggerManager.getActionESP(GUID guid)
Returns the trigger action ESP for the given GUID.
|
GUID[] |
TriggerManager.getActionsAvailable(int condition)
Returns an array of GUIDs of available action ESPs supporting the given condition.
|
java.util.Collection<Trigger> |
TriggerManager.getCatalogTriggers(Catalog catalog)
Returns a collection of all existing triggers for the given catalog.
|
java.util.Collection<Trigger> |
TriggerManager.getCategoriesTriggers(Catalog catalog)
Returns a collection of all existing triggers for all categories of the given catalog.
|
java.util.Collection<Trigger> |
TriggerManager.getItemTriggers(Item item)
Returns a collection of all existing triggers for the given item.
|
java.util.Collection<Trigger> |
TriggerManager.getRecordsTriggers(Catalog catalog)
Returns a collection of all existing triggers for all records of the given catalog.
|
java.util.Collection |
TriggerManager.getServerTriggers()
Returns a collection of all existing server triggers.
|
void |
TriggerManager.removeCatalogTrigger(Catalog catalog,
Trigger trigger)
Removes the given trigger as a catalog trigger.
|
void |
TriggerManager.removeCategoriesTrigger(Catalog catalog,
Trigger trigger)
Removes the given trigger as a trigger for all categories of the specified catalog.
|
void |
TriggerManager.removeItemTrigger(Item item,
Trigger trigger)
Removes the given trigger as a trigger for the specified record.
|
void |
TriggerManager.removeRecordsTrigger(Catalog catalog,
Trigger trigger)
Removes the given trigger as a trigger for all records of the specified catalog.
|
void |
TriggerManager.removeServerTrigger(Trigger trigger)
Removes the given trigger as a server trigger.
|
void |
Trigger.save()
Saves this trigger.
|
| Modifier and Type | Method and Description |
|---|---|
Asset |
AssetReference.getAsset(boolean allowProxyAsset)
Resolves the asset reference data and returns the asset object, using the default asset handling set.
|
| Modifier and Type | Method and Description |
|---|---|
Workflow |
CatalogWorkflowList.add(Workflow workflow)
Adds the given workflow.
|
AssetAction |
AssetActionsList.copy(java.lang.String newName,
AssetAction copySource)
Duplicates the given asset action and stores the result under the specified name.
|
AssetAction |
AssetActionsList.copy(java.lang.String newName,
AssetAction copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given asset action and stores the result under the specified name.
|
AssetHandlingSet |
AssetHandlingSetList.copy(java.lang.String newName,
AssetHandlingSet copySource)
Duplicates the given asset handling set and stores the result under the specified name.
|
AssetHandlingSet |
AssetHandlingSetList.copy(java.lang.String newName,
AssetHandlingSet copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given asset handling set and stores the result under the specified name.
|
BackupJob |
BackupJobList.copy(java.lang.String newName,
BackupJob copySource)
Duplicates the given backup job and stores the result under the specified name.
|
CatalogTemplate |
CatalogTemplateList.copy(java.lang.String newName,
CatalogSettingsRoot copySource)
Copies the given catalog into a new Catalog Template and stores the result under the specified name.
|
CatalogTemplate |
CatalogTemplateList.copy(java.lang.String newName,
CatalogSettingsRoot copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Copies the given catalog into a new Catalog Template and stores the result under the specified name.
|
CatalogTemplate |
CatalogTemplateList.copy(java.lang.String newName,
CatalogTemplate copySource)
Duplicates the given catalog template and stores the result under the specified name.
|
CatalogTemplate |
CatalogTemplateList.copy(java.lang.String newName,
CatalogTemplate copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given catalog template and stores the result under the specified name.
|
CategoryViewSet |
CategoryViewSetList.copy(java.lang.String newName,
CategoryViewSet copySource)
Duplicates the given category view set and stores the result under the specified name.
|
CategoryViewSet |
CategoryViewSetList.copy(java.lang.String newName,
CategoryViewSet copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given category view set and stores the result under the specified name.
|
CropTemplate |
CropTemplatesList.copy(java.lang.String newName,
CropTemplate copySource)
Duplicates the given crop template and stores the result under the specified name.
|
CropTemplate |
CropTemplatesList.copy(java.lang.String newName,
CropTemplate copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given crop template and stores the result under the specified name.
|
EmailClass |
EmailClassesList.copy(java.lang.String newName,
EmailClass copySource)
Duplicates the given email class and stores the result under the specified name.
|
EmailClass |
EmailClassesList.copy(java.lang.String newName,
EmailClass copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given email class and stores the result under the specified name.
|
EmailLayout |
EmailLayoutsList.copy(java.lang.String newName,
EmailLayout copySource)
Duplicates the given email layout and stores the result under the specified name.
|
EmailLayout |
EmailLayoutsList.copy(java.lang.String newName,
EmailLayout copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given email layout and stores the result under the specified name.
|
Item |
WorkflowList.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given workflow with the specified UID.
|
Item |
RecordViewSetList.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given item with the specified UID.
|
Item |
RecordFilterList.copy(java.lang.String id,
Item item,
boolean copyDisplayNames,
boolean copyDescriptions) |
Item |
PrintSetsList.copy(java.lang.String id,
Item item,
boolean copyDisplayNames,
boolean copyDescriptions) |
Item |
PermissionTemplatesList.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given item with the specified UID.
|
Item |
MetadataTemplatesList.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given item with the specified UID.
|
Item |
ItemManager.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given item with the specified UID.
|
Item |
EmailLayoutsList.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given email layout with the specified layout ID.
|
Item |
EmailClassesList.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given email class with the specified class ID.
|
Item |
CropTemplatesList.copy(java.lang.String id,
Item item,
boolean copyDisplayNames,
boolean copyDescriptions) |
Item |
CollectionSetList.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given item with the specified UID.
|
Item |
CategoryViewSetList.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given item with the specified UID.
|
Item |
CatalogTemplateList.copy(java.lang.String id,
Item item,
boolean copyDisplayNames,
boolean copyDescriptions) |
Item |
BaseQueriesList.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given item with the specified UID.
|
Item |
AssetRelationList.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions) |
Item |
AssetHandlingSetList.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given item with the specified UID.
|
Item |
AssetActionsList.copy(java.lang.String newID,
Item src,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given item with the specified UID.
|
MetadataTemplate |
MetadataTemplatesList.copy(java.lang.String newName,
MetadataTemplate copySource)
Duplicates the given metadata template and stores the result under the specified name.
|
MetadataTemplate |
MetadataTemplatesList.copy(java.lang.String newName,
MetadataTemplate copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given metadata template and stores the result under the specified name.
|
PermissionTemplate |
PermissionTemplatesList.copy(java.lang.String newName,
PermissionTemplate copySource)
Duplicates the given permission template and stores the result under the specified name.
|
PermissionTemplate |
PermissionTemplatesList.copy(java.lang.String newName,
PermissionTemplate copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given permission template and stores the result under the specified name.
|
PrintSet |
PrintSetsList.copy(java.lang.String newName,
PrintSet copySource)
Duplicates the given print set and stores the result under the specified name.
|
PrintSet |
PrintSetsList.copy(java.lang.String newName,
PrintSet copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given print set and stores the result under the specified name.
|
RecordFilter |
RecordFilterList.copy(java.lang.String newName,
RecordFilter copySource)
Duplicates the given record filter and stores the result under the specified name.
|
RecordFilter |
RecordFilterList.copy(java.lang.String newName,
RecordFilter copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given record filter and stores the result under the specified name.
|
RecordViewSet |
RecordViewSetList.copy(java.lang.String newName,
RecordViewSet copySource)
Duplicates the given record view set and stores the result under the specified name.
|
RecordViewSet |
RecordViewSetList.copy(java.lang.String newName,
RecordViewSet copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given record view set and stores the result under the specified name.
|
ReportSet |
ReportSetList.copy(java.lang.String newName,
ReportSet copySource)
Duplicates the given report set and stores the result under the specified name.
|
SchedulerJob |
SchedulerJobList.copy(java.lang.String newName,
SchedulerJob copySource)
Duplicates the given scheduler job and stores the result under the specified name.
|
Workflow |
WorkflowList.copy(java.lang.String newName,
Workflow copySource)
Duplicates the given workflow and stores the result under the specified name.
|
Workflow |
WorkflowList.copy(java.lang.String newName,
Workflow copySource,
boolean copyDisplayNames,
boolean copyDescriptions)
Duplicates the given workflow and stores the result under the specified name.
|
SchedulerJob |
SchedulerJobList.create(java.lang.String name)
Creates a new scheduler job using the given name.
|
ReportSet |
ReportSetList.create(java.lang.String name)
Creates a new report set using the given name.
|
MetadataTemplate |
MetadataTemplatesList.create(java.lang.String newName)
Creates an empty metadata template and stores it under the specified name.
|
BackupJob |
BackupJobList.create(java.lang.String name)
Creates a new backup job using the given name.
|
CollectionSet |
CollectionSetList.create(java.lang.String newName,
CollectionType collectionType,
MultiRecordItemCollection multiRecordItemCollection)
Creates a new collection set using the given name.
|
CollectionSet |
CollectionSetList.create(java.lang.String collectionSetName,
CollectionType collectionType,
java.util.Set<Catalog> catalogs,
java.lang.String query,
java.util.EnumSet<FindFlag> flags,
java.util.Locale locale)
Creates a new query based collection set using the given name and type (supported type is
CollectionType.UPLOAD_COLLECTION). |
Query |
RecordQueriesList.create(java.lang.String newName,
java.lang.String queryString,
boolean isComplex)
Creates a new query using the given name.
|
Query |
CategoryQueriesList.create(java.lang.String newName,
java.lang.String queryString,
boolean isComplex)
Creates a new query using the given name.
|
Query |
BaseQueriesList.create(java.lang.String newName,
java.lang.String queryString,
boolean isComplex) |
void |
AssetActionsList.delete(AssetAction setToDelete)
Deletes the given asset action.
|
void |
AssetHandlingSetList.delete(AssetHandlingSet handlingSet)
Deletes the given asset handling set.
|
void |
CatalogAssetRelationList.delete(AssetRelation assetRelation)
Deletes the given asset relation.
|
void |
BackupJobList.delete(BackupJob setToDelete)
Deletes the given backup job.
|
void |
CatalogTemplateList.delete(CatalogTemplate setToDelete)
Deletes the given catalog template.
|
void |
CategoryViewSetList.delete(CategoryViewSet setToDelete)
Deletes the given category view set.
|
void |
CollectionSetList.delete(CollectionSet collectionSetToDelete)
Deletes the given collection set.
|
void |
CropTemplatesList.delete(CropTemplate setToDelete)
Deletes the given crop template.
|
void |
CustomDataList.delete(CustomDataListEntry entry)
Deletes the given instance.
|
void |
EmailClassesList.delete(EmailClass emailClass)
Deletes the given email class.
|
void |
EmailClassPlaceholderList.delete(EmailClassPlaceholder placeholder)
Deletes the given placeholder.
|
void |
EmailClassTemplateList.delete(EmailClassTemplate template)
Deletes the given template.
|
void |
EmailLayoutsList.delete(EmailLayout emailLayout)
Deletes the given email layout.
|
void |
EmailLayoutAttachmentsList.delete(EmailLayoutAttachment attachment)
Deletes the given attachment.
|
void |
WorkflowList.delete(Item item)
Deletes the given item.
|
void |
RecordViewSetList.delete(Item item)
Deletes the given item.
|
void |
RecordFilterList.delete(Item item) |
void |
PrintSetsList.delete(Item item) |
void |
PermissionTemplatesList.delete(Item item)
Deletes the given item.
|
void |
MetadataTemplatesList.delete(Item item)
Deletes the given item.
|
void |
ItemManager.delete(Item item)
Deletes the given item.
|
void |
EmailLayoutsList.delete(Item item)
Deletes the given item.
|
void |
EmailClassesList.delete(Item item)
Deletes the given item.
|
void |
CropTemplatesList.delete(Item item) |
void |
CollectionSetList.delete(Item item)
Deletes the given item.
|
void |
CategoryViewSetList.delete(Item item)
Deletes the given item.
|
void |
CatalogTemplateList.delete(Item item) |
void |
BaseQueriesList.delete(Item item)
Deletes the given item.
|
void |
AssetRelationList.delete(Item item) |
void |
AssetHandlingSetList.delete(Item item)
Deletes the given item.
|
void |
AssetActionsList.delete(Item item)
Deletes the given item.
|
void |
MetadataTemplatesList.delete(MetadataTemplate setToDelete)
Deletes the given metadata template.
|
void |
PermissionTemplatesList.delete(PermissionTemplate setToDelete)
Deletes the given permission template.
|
void |
PrintSetsList.delete(PrintSet setToDelete)
Deletes the given print set.
|
void |
RecordQueriesList.delete(Query setToDelete)
Deletes the given query.
|
void |
CategoryQueriesList.delete(Query setToDelete)
Deletes the given query.
|
void |
BaseQueriesList.delete(Query setToDelete) |
void |
RecordFilterList.delete(RecordFilter setToDelete)
Deletes the given record filter.
|
void |
RecordViewSetList.delete(RecordViewSet setToDelete)
Deletes the given record view set.
|
void |
ReportSetList.delete(ReportSet setToDelete)
Deletes the given report set.
|
void |
SchedulerJobList.delete(SchedulerJob setToDelete)
Deletes the given scheduler job.
|
void |
WorkflowList.delete(Workflow workflow)
Deletes the given workflow.
|
void |
CatalogWorkflowList.delete(Workflow workflow)
Deletes the given workflow and the related catalog fields.
|
Workflow |
WorkflowList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported workflow data into a new workflow.
|
SchedulerJob |
SchedulerJobList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
RecordViewSet |
RecordViewSetList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
RecordFilter |
RecordFilterList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
PrintSet |
PrintSetsList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
PermissionTemplate |
PermissionTemplatesList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
MetadataTemplate |
MetadataTemplatesList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
EmailLayout |
EmailLayoutsList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported email layout data into a new email layout.
|
EmailClass |
EmailClassesList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported email class data into a new email class.
|
CropTemplate |
CropTemplatesList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
CategoryViewSet |
CategoryViewSetList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
CatalogTemplate |
CatalogTemplateList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
Query |
BaseQueriesList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
BackupJob |
BackupJobList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
AssetHandlingSet |
AssetHandlingSetList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
AssetAction |
AssetActionsList.importSet(JPack data,
SetImportDuplicatesMode duplicatesMode)
Imports the given exported set data into a new set.
|
void |
MetadataTemplate.processItem(Item item,
java.util.Set<GUID> restrictedFieldList,
boolean saveItem,
MetadataTemplate.ChangeCallback changeCallback)
Applies this template on the given item.
|
void |
AssetActionsList.rename(java.lang.String newName,
AssetAction setToRename)
Renames the given asset action to the new specified name.
|
void |
AssetActionsList.rename(java.lang.String newName,
AssetAction setToRename,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given asset action to the new specified name.
|
void |
AssetHandlingSetList.rename(java.lang.String newName,
AssetHandlingSet handlingSet)
Renames the given asset handling set to the new specified name.
|
void |
AssetHandlingSetList.rename(java.lang.String newName,
AssetHandlingSet handlingSet,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given asset handling set to the new specified name.
|
void |
CatalogTemplateList.rename(java.lang.String newName,
CatalogTemplate setToRename)
Renames the given catalog template to the new specified name.
|
void |
CatalogTemplateList.rename(java.lang.String newName,
CatalogTemplate setToRename,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given catalog template to the new specified name.
|
void |
CategoryViewSetList.rename(java.lang.String newName,
CategoryViewSet setToRename)
Renames the given category view set to the new specified name.
|
void |
CategoryViewSetList.rename(java.lang.String newName,
CategoryViewSet setToRename,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given category view set to the new specified name.
|
void |
CropTemplatesList.rename(java.lang.String newName,
CropTemplate setToRename)
Renames the given crop template to the new specified name.
|
void |
CropTemplatesList.rename(java.lang.String newName,
CropTemplate setToRename,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given crop template to the new specified name.
|
void |
EmailClassesList.rename(java.lang.String newName,
EmailClass emailClass)
Renames the given email class to the new specified name.
|
void |
EmailClassesList.rename(java.lang.String newName,
EmailClass emailClass,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given email class to the new specified name.
|
void |
EmailClassPlaceholderList.rename(java.lang.String newName,
EmailClassPlaceholder placeholder)
Renames the given placeholder to the new specified name.
|
void |
EmailClassTemplateList.rename(java.lang.String newName,
EmailClassTemplate template)
Renames the given template to the new specified name.
|
void |
EmailLayoutsList.rename(java.lang.String newName,
EmailLayout emailLayout)
Renames the given email layout to the new specified name.
|
void |
EmailLayoutsList.rename(java.lang.String newName,
EmailLayout emailLayout,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given email layout to the new specified name.
|
void |
WorkflowList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given item to the new UID.
|
void |
RecordViewSetList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given item to the new UID.
|
void |
RecordFilterList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions) |
void |
PrintSetsList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions) |
void |
PermissionTemplatesList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given item to the new UID.
|
void |
MetadataTemplatesList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given item to the new UID.
|
void |
ItemManager.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given item to the new UID.
|
void |
EmailLayoutsList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given item to the new UID.
|
void |
EmailClassesList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given item to the new UID.
|
void |
CropTemplatesList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions) |
void |
CollectionSetList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given item to the new UID.
|
void |
CategoryViewSetList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given item to the new UID.
|
void |
CatalogTemplateList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions) |
void |
BaseQueriesList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given item to the new UID.
|
void |
AssetRelationList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions) |
void |
AssetHandlingSetList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given item to the new UID.
|
void |
AssetActionsList.rename(java.lang.String newID,
Item item,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given item to the new UID.
|
void |
MetadataTemplatesList.rename(java.lang.String newName,
MetadataTemplate setToRename)
Renames the given metadata template to the new specified name.
|
void |
MetadataTemplatesList.rename(java.lang.String newName,
MetadataTemplate setToRename,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given metadata template to the new specified name.
|
void |
PermissionTemplatesList.rename(java.lang.String newName,
PermissionTemplate setToRename)
Renames the given permission template to the new specified name.
|
void |
PermissionTemplatesList.rename(java.lang.String newName,
PermissionTemplate setToRename,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given permission template to the new specified name.
|
void |
PrintSetsList.rename(java.lang.String newName,
PrintSet setToRename)
Renames the given print set to the new specified name.
|
void |
PrintSetsList.rename(java.lang.String newName,
PrintSet setToRename,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given print set to the new specified name.
|
void |
RecordFilterList.rename(java.lang.String newName,
RecordFilter setToRename)
Renames the given record filter to the new specified name.
|
void |
RecordFilterList.rename(java.lang.String newName,
RecordFilter setToRename,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given record filter to the new specified name.
|
void |
RecordViewSetList.rename(java.lang.String newName,
RecordViewSet setToRename)
Renames the given record view set to the new specified name.
|
void |
RecordViewSetList.rename(java.lang.String newName,
RecordViewSet setToRename,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given record view set to the new specified name.
|
void |
WorkflowList.rename(java.lang.String newName,
Workflow workflow)
Renames the given workflow to the new specified name.
|
void |
WorkflowList.rename(java.lang.String newName,
Workflow workflow,
boolean keepDisplayNames,
boolean keepDescriptions)
Renames the given workflow to the new specified name.
|
void |
PreferencesImpl.writePreferencesForLocalUser()
Writes all available preferences to the local preferences store.
|
| Modifier and Type | Method and Description |
|---|---|
ToolbarButton |
Toolbar.getButtonByID(int id)
Returns a button by ID.
|
Menu |
MenuBar.getMenu(java.lang.String name)
Returns a menu by name.
|
Menu |
MenuBar.getMenuByID(int id)
Returns a menu by ID.
|
MenuItem |
Menu.getMenuItem(java.lang.String name)
Returns a menu item by name.
|
MenuItem |
Menu.getMenuItemByID(int command)
Returns a menu item by ID.
|
void |
MenuBar.removeMenu(Menu menu)
Removes a menu from the menu bar.
|
void |
MenuBar.removeMenuByID(int id)
Removes a menu by ID.
|
void |
Menu.removeMenuItem(MenuItem item)
Removes a menu item.
|
void |
Menu.removeMenuItemByID(int command)
Removes a menu item by ID.
|
| Modifier and Type | Method and Description |
|---|---|
UserFieldDefinition |
AuthenticationManager.createFieldDefinition(java.lang.String sName,
int type)
Creates a new field definition.
|
OpenCatalogClientGroup |
AuthenticationManager.createOpenCatalogClientGroup(java.lang.String name)
Creates a new Open Catalog Client Group.
|
Role |
AuthenticationManager.createRole(java.lang.String sRoleName)
Create a new Role.
|
User |
AuthenticationManager.createUser(java.lang.String sUserName)
Create a new user.
|
void |
AuthenticationManager.deleteFieldDefinition(GUID guid)
Deletes a field definition.
|
void |
AuthenticationManager.deleteOpenCatalogClientGroup(java.lang.String name)
Delete the specified group at the server.
|
void |
AuthenticationManager.deleteRole(java.lang.String sRoleName)
Delete an existing role.
|
void |
AuthenticationManager.deleteUser(java.lang.String sUserName)
Delete an existing user
|
OpenCatalogClientGroup |
AuthenticationManager.duplicate(java.lang.String newName,
OpenCatalogClientGroup clientGroup)
Duplicates the given group using the specified name as the name of the copy.
|
Role |
AuthenticationManager.duplicateRole(java.lang.String sOldName,
java.lang.String newName)
Duplicates the specified role as a new role.
|
User |
AuthenticationManager.duplicateUser(java.lang.String sOldName,
java.lang.String newName)
Duplicates the specified user as a new user.
|
static AuthenticationManager |
AuthenticationManager.getAuthenticationManager(Server server)
Get the authentication manager for the specified server instance.
|
ProductList |
AuthenticationManager.getAvailableProductList()
Returns the available products of the server.
|
java.util.Map<java.lang.Integer,java.lang.String> |
AuthenticationManager.getDepartmentIDs()
Returns a map of all department ids pointing to their name.
|
AuthenticationManager.Department |
AuthenticationManager.getDepartments()
Returns the configured departments if the feature is enabled for the server.
|
UserFieldDefinition |
AuthenticationManager.getFieldDefinition(GUID guid)
Returns a field definition by GUID from the global field definition cache.
|
GUID[] |
AuthenticationManager.getFieldDefinitionGUIDsAsArray()
Returns an array containing the field GUIDs.
|
UserFieldDefinition[] |
AuthenticationManager.getFieldDefinitions()
Returns all field definitions available at the server for user management (those fields are part of the $Users catalog).
|
OpenCatalogClientGroup |
AuthenticationManager.getOpenCatalogClientGroup(java.lang.String name)
Returns the group instance for the specified name.
|
java.util.List<java.lang.String> |
AuthenticationManager.getOpenCatalogClientGroupNames()
Get a list of names of all existing groups.
|
Role |
AuthenticationManager.getRole(java.lang.String sRole)
Returns a role by name.
|
java.lang.String[] |
AuthenticationManager.getRoleNamesAsArray()
Returns an array containing the list of roles.
|
AuthenticationManager.ServerSettings |
AuthenticationManager.getServerSettings()
Returns the
AuthenticationManager.ServerSettings which provide additional information about the server. |
java.util.List<User> |
AuthenticationManager.getStrippedUsers(AuthenticationManager.UserType userType,
GUID[] guids)
Returns a list of
User objects which only contain the information for the specified list of fields. |
java.util.List<User> |
AuthenticationManager.getStrippedUsers(GUID[] guids)
Returns a list of
User objects which only contain the information for the specified list of fields. |
User |
AuthenticationManager.getUser(java.lang.String sUser)
Returns a user by name.
|
java.lang.String[] |
AuthenticationManager.getUserNamesAsArray()
Returns an array containing the list of users.
|
java.lang.String[] |
AuthenticationManager.getUserRoleNamesAsArray(java.lang.String sUser)
Returns an array containing the list of roles for a specific user.
|
boolean |
AuthenticationManager.isAdmin()
Return whether you are connected as the Cumulus administrator.
|
boolean |
AuthenticationManager.isSimpleMode()
Returns whether the user management at the server runs in Simple Mode (no support for roles).
|
void |
AuthenticationManager.renameOpenCatalogClientGroup(java.lang.String oldName,
java.lang.String newName)
Renames the group to the specified new name.
|
void |
AuthenticationManager.renameRole(java.lang.String sRoleName,
java.lang.String sNewRoleName)
Renames a role.
|
void |
AuthenticationManager.saveFieldDefinition(UserFieldDefinition field)
Save the changes for the field definition back to the server.
|
void |
AuthenticationManager.saveOpenCatalogClientGroup(OpenCatalogClientGroup clientGroup)
Save all changes for the group back to the server.
|
void |
AuthenticationManager.saveRole(Role role)
Save the changes for the specified role back to the server.
|
void |
AuthenticationManager.saveUser(User user)
Save the changes for the specified user back to the server.
|
void |
AuthenticationManager.setAdvancedMode()
Calling this function switches the server to Advanced Mode if this feature is available at the server.
|
void |
AuthenticationManager.setDepartments(AuthenticationManager.Department department)
Saves all departments.
|
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.