| Package | Description |
|---|---|
| com.canto.cumulus |
The base package of the Cumulus Java Classes.
|
| com.canto.cumulus.fieldvalue |
Wrapper clsses for field values of the Cumulus Java Classes.
|
| Modifier and Type | Method and Description |
|---|---|
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.
|
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.
|
CategoryItemCollection |
MultiCategoryItemCollection.getCategoryItemCollection(int catalogID)
Return the contained CategoryItemCollection for the given catalog ID.
|
CategoryItem |
CategoryItemCollection.getCategoryTreeItemByIndex(int index,
java.util.Set<java.lang.Integer> expandedCategoryIDs)
Get the ID of the category specified by index in the tree assuming a set of categories being expanded.
|
int |
CategoryItemCollection.getCategoryTreeItemIDByPath(CategoryItem parent,
java.lang.String path)
Returns the ID of the category with the given relative tree path underneath a given category.
|
int |
CategoryItemCollection.getCategoryTreeItemIDByPath(java.lang.String path)
Returns the ID of the category with the given tree path.
|
int |
CategoryItemCollection.getCategoryTreeItemIndex(int categoryItemID,
java.util.Set<java.lang.Integer> expandedCategoryIDs)
Return the index of a given category in the tree assuming a set of categories being expanded.
|
FieldDefinition |
MultiLayout.getFieldDefinition(GUID fieldUID)
Returns the
FieldDefinition for the specified fieldUID or throws an Exception if that field is
not contained in this layout (read: in any of the catalogs of the MultiItemCollection). |
FieldDefinition |
Layout.getFieldDefinition(GUID fieldUID)
Returns the
FieldDefinition for the specified fieldUID or throws an Exception if that field is
not contained in this layout. |
java.util.Map<java.lang.Integer,FieldDefinition> |
MultiLayout.getFieldDefinitions(GUID fieldUID)
Returns the
FieldDefinition instances for the specified fieldUID of all catalogs. |
RecordItemCollection |
MultiRecordItemCollection.getRecordItemCollection(int catalogID)
Return the contained RecordItemCollection for the given catalog ID.
|
java.lang.String |
FieldDefinition.getStringEnumDescription(int enumID)
Returns the textual string enum description for the current language.
|
java.lang.String |
FieldDefinition.getStringEnumDescription(int enumID,
int languageID)
Returns the textual string enum description for the specified language.
|
java.util.List<java.lang.Integer> |
FieldDefinition.getStringEnumIDs()
Returns for a field of type string enum the list of string enum IDs in sorted order for the current language.
|
java.util.List<java.lang.Integer> |
FieldDefinition.getStringEnumIDs(int languageID)
Returns for a field of type string enum the list of string enum IDs in sorted order for the specified language.
|
java.lang.String |
FieldDefinition.getStringEnumName(int enumID)
Returns the textual string enum representation for the current language.
|
java.lang.String |
FieldDefinition.getStringEnumName(int enumID,
int languageID)
Returns the textual string enum representation for the specified language.
|
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.
|
AssetReference |
Asset.newAssetReference(java.lang.String assetHandlingSet)
Create a new asset reference for this asset.
|
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. |
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. |
void |
MultiItemCollection.removeItemCollection(int catalogID)
Remove the ItemCollection of the given catalog from this collection.
|
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.
|
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.
|
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.
|
| Constructor and Description |
|---|
Asset(CumulusSession session,
java.io.File fileOrFolder,
java.lang.String assetHandlingSet)
Creates a new
Asset object from the given file or folder object, using a specific asset handling set. |
Asset(CumulusSession session,
java.lang.String sXML,
java.lang.String assetHandlingSet)
Creates a new
Asset object from the given AssetReference in XML format, using a specific asset handling set. |
| Modifier and Type | Method and Description |
|---|---|
void |
CategoriesFieldValue.addID(int categoryID)
Add a single category assignment to the list.
|
void |
CategoriesFieldValue.addIDs(java.util.Set<java.lang.Integer> categoryIDs)
Add category assignments to the list.
|
void |
CategoriesFieldValue.removeID(int categoryID)
Remove one category assignment.
|
void |
CategoriesFieldValue.removeIDs(java.util.Set<java.lang.Integer> categoryIDs)
Remove some category assignments.
|
void |
LengthInInchFieldValue.setFromDisplayString(java.util.Locale locale,
MeasurementUnit measurementUnit,
java.lang.String value)
Set the field value from a display string using a specific locale for formatting and language selection.
|
void |
VocabularyFieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
Set the field value from a display string.
|
void |
UserUIDFieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
This method is not supported.
|
void |
TimeOnlyFieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
Set the field value from a display string.
|
void |
StringEnumFieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
Set the field value from a display string.
|
void |
ResolutionFieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
Set the field value from a display string using a specific locale for formatting and language selection.
|
void |
RatingFieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
Set the field value from a display string.
|
void |
LengthInInchFieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
Set the field value from a display string using a specific locale for formatting and language selection.
|
void |
LabelFieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
Set the label field value from a string representation of the color.
|
void |
FieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
Set the field value from a display string using a specific locale for formatting and language selection.
|
void |
DateOnlyFieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
Set the field value from a display string using a specific locale for formatting and language selection.
|
void |
DataSizeFieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
Set the field value from a display string using a specific locale for formatting and language selection.
|
void |
CategoriesFieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
This method is not supported for categories.
|
void |
AssetXRefFieldValue.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
This method is not supported for asset cross reference values.
|
void |
AssetReference.setFromDisplayString(java.util.Locale locale,
java.lang.String value)
This method is not supported for asset reference values.
|
void |
VocabularyFieldValue.setFromDisplayString(java.lang.String value)
Set the field value from a display string.
|
void |
UserUIDFieldValue.setFromDisplayString(java.lang.String value)
This method is not supported.
|
void |
TimeOnlyFieldValue.setFromDisplayString(java.lang.String value)
Set the field value from a display string.
|
void |
StringEnumFieldValue.setFromDisplayString(java.lang.String value)
Set the field value from a display string.
|
void |
ResolutionFieldValue.setFromDisplayString(java.lang.String value)
Set the field value from a display string.
|
void |
RatingFieldValue.setFromDisplayString(java.lang.String value)
Set the field value from a display string.
|
void |
LengthInInchFieldValue.setFromDisplayString(java.lang.String value)
Set the field value from a display string.
|
void |
LabelFieldValue.setFromDisplayString(java.lang.String value)
Set the label field value from a string representation of the color.
|
void |
FieldValue.setFromDisplayString(java.lang.String value)
Set the field value from a display string.
|
void |
DateOnlyFieldValue.setFromDisplayString(java.lang.String value)
Set the field value from a display string.
|
void |
DataSizeFieldValue.setFromDisplayString(java.lang.String value)
Set the field value from a display string.
|
void |
CategoriesFieldValue.setFromDisplayString(java.lang.String value)
This method is not supported for categories.
|
void |
AssetXRefFieldValue.setFromDisplayString(java.lang.String value)
This method is not supported for asset cross reference values.
|
void |
AssetReference.setFromDisplayString(java.lang.String value)
This method is not supported for asset reference values.
|
void |
VocabularyFieldValue.setID(int enumID)
Set the ID of this string list value.
|
void |
StringEnumFieldValue.setID(int enumID)
Set the ID of this string list value.
|
void |
VocabularyFieldValue.setIDs(java.util.Set<java.lang.Integer> ids)
Set the field value to the given set of string list IDs.
|
void |
StringEnumFieldValue.setIDs(java.util.Set<java.lang.Integer> ids)
Set the field value to the given set of string list IDs.
|
void |
CategoriesFieldValue.setIDs(java.util.Set<java.lang.Integer> categoryIDs)
Set the list of assigned categories.
|
void |
RatingFieldValue.setRating(int stars)
Set the field value using a number of stars representing a rating.
|
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.