AssetUsage (Cumulus Java Classes Documentation)

java.lang.Object
- java.lang.Enum<AssetUsage>
- - com.canto.cumulus.constants.AssetUsage

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AssetUsage>
```
public enum AssetUsage
extends java.lang.Enum<AssetUsage>
```
This enum specifies all available types of asset usages that can be logged by the cumulus server.

Since:

8.0

See Also:
Item.logUsage(AssetUsage, String)

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CHECKIN` Asset has been checked in.
`CHECKOUT` Asset has been checked out.
`COLLECT_FOR_CD` Asset has been collected for CD.
`COMMENTED` A comment on an asset was added, modified or deleted.
`CONVERT` Asset has been converted.
`COPY_TO` Asset has been copied.
`COPY_TO_BACKUP` Asset was copied to a backup.
`CREATE_SLIDE_SHOW` Asset has been used for a slideshow.
`CREATE_WEB_ALBUM` Asset has been used for a web album.
`DOWNLOAD` Asset has been downloaded.
`EDIT_WITH_APPLICATION` The Edit with Application function has been called on the Asset.
`MAIL_TO` Asset has been mailed.
`MOVE_TO` Asset has been moved.
`MOVE_TO_ARCHIVE` Asset was moved to an archive.
`PERFORM_ACTION` Asset was processed using an asset action.
`PREVIEW` Asset has been previewed.
`PRINT_USING_PRINT_SET` Asset has been printed using a print set.
`PRINT_WITH_APPLICATION` The Print with Application function has been called on the Asset.
`PUBLISH_IN_VIDEO_CLOUD` Asset was requested to publish in Video Cloud.
`REMOVE_FROM_VIDEO_CLOUD` Asset was requested to remove from Video Cloud.
`RESTORE_FROM_ARCHIVE` Asset was restored from an archive.
`RESTORE_FROM_BACKUP` Asset was restored from a backup.
`SHOW_LOCATION` Asset has been located using the Show Location function.
`SHOW_ORIGINAL` Asset was sent as Original for the Show Original functionality.
`TRANSFORM_ORIGINAL` Asset has been rotated with the Transform Original JPEG function.
`UNDO_CHECKOUT` Checkout state of an Asset has been cleared.
`UNPUBLISH_IN_VIDEO_CLOUD` Asset was requested to unpublish in Video Cloud.
`UPDATE` Asset record was updated from asset.
`UPDATE_ASSET_REFERENCE` Asset reference was updated for record.
`UPLOAD_TO_VIDEO_CLOUD` Asset was requested to upload to Video Cloud.
`WRITE_METADATA_TO_ASSET` Metadata has been written to the Asset.

Method Summary

Methods
Modifier and Type	Method and Description
`static AssetUsage`	`findAssetUsage(int id)` Finds the usage for the given id.
`int`	`getUsageID()` Returns the id of this usage.
`java.lang.String`	`toString()`
`static AssetUsage`	`valueOf(java.lang.String name)` Returns the enum constant of this type with the specified name.
`static AssetUsage[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - PREVIEW
```
public static final AssetUsage PREVIEW
```
    Asset has been previewed.
  - COPY_TO
```
public static final AssetUsage COPY_TO
```
    Asset has been copied.
  - MOVE_TO
```
public static final AssetUsage MOVE_TO
```
    Asset has been moved.
  - MAIL_TO
```
public static final AssetUsage MAIL_TO
```
    Asset has been mailed.
  - PERFORM_ACTION
```
public static final AssetUsage PERFORM_ACTION
```
    Asset was processed using an asset action.
  - CONVERT
```
public static final AssetUsage CONVERT
```
    Asset has been converted.
  - CREATE_SLIDE_SHOW
```
public static final AssetUsage CREATE_SLIDE_SHOW
```
    Asset has been used for a slideshow.
  - CREATE_WEB_ALBUM
```
public static final AssetUsage CREATE_WEB_ALBUM
```
    Asset has been used for a web album.
  - CHECKOUT
```
public static final AssetUsage CHECKOUT
```
    Asset has been checked out.
  - CHECKIN
```
public static final AssetUsage CHECKIN
```
    Asset has been checked in.
  - UNDO_CHECKOUT
```
public static final AssetUsage UNDO_CHECKOUT
```
    Checkout state of an Asset has been cleared.
  - TRANSFORM_ORIGINAL
```
public static final AssetUsage TRANSFORM_ORIGINAL
```
    Asset has been rotated with the Transform Original JPEG function.
  - SHOW_LOCATION
```
public static final AssetUsage SHOW_LOCATION
```
    Asset has been located using the Show Location function.
  - WRITE_METADATA_TO_ASSET
```
public static final AssetUsage WRITE_METADATA_TO_ASSET
```
    Metadata has been written to the Asset.
  - EDIT_WITH_APPLICATION
```
public static final AssetUsage EDIT_WITH_APPLICATION
```
    The Edit with Application function has been called on the Asset.
  - PRINT_WITH_APPLICATION
```
public static final AssetUsage PRINT_WITH_APPLICATION
```
    The Print with Application function has been called on the Asset.
  - PRINT_USING_PRINT_SET
```
public static final AssetUsage PRINT_USING_PRINT_SET
```
    Asset has been printed using a print set.
  - DOWNLOAD
```
public static final AssetUsage DOWNLOAD
```
    Asset has been downloaded.
  - COLLECT_FOR_CD
```
public static final AssetUsage COLLECT_FOR_CD
```
    Asset has been collected for CD.
  - SHOW_ORIGINAL
```
public static final AssetUsage SHOW_ORIGINAL
```
    Asset was sent as Original for the Show Original functionality.
  - UPDATE
```
public static final AssetUsage UPDATE
```
    Asset record was updated from asset.
  - UPDATE_ASSET_REFERENCE
```
public static final AssetUsage UPDATE_ASSET_REFERENCE
```
    Asset reference was updated for record.
  - COPY_TO_BACKUP
```
public static final AssetUsage COPY_TO_BACKUP
```
    Asset was copied to a backup.
  - RESTORE_FROM_BACKUP
```
public static final AssetUsage RESTORE_FROM_BACKUP
```
    Asset was restored from a backup.
  - MOVE_TO_ARCHIVE
```
public static final AssetUsage MOVE_TO_ARCHIVE
```
    Asset was moved to an archive.
  - RESTORE_FROM_ARCHIVE
```
public static final AssetUsage RESTORE_FROM_ARCHIVE
```
    Asset was restored from an archive.
  - COMMENTED
```
public static final AssetUsage COMMENTED
```
    A comment on an asset was added, modified or deleted.
  - UPLOAD_TO_VIDEO_CLOUD
```
public static final AssetUsage UPLOAD_TO_VIDEO_CLOUD
```
    Asset was requested to upload to Video Cloud.
    
    Since:
    
    10.1.3
  - PUBLISH_IN_VIDEO_CLOUD
```
public static final AssetUsage PUBLISH_IN_VIDEO_CLOUD
```
    Asset was requested to publish in Video Cloud.
    
    Since:
    
    10.1.3
  - UNPUBLISH_IN_VIDEO_CLOUD
```
public static final AssetUsage UNPUBLISH_IN_VIDEO_CLOUD
```
    Asset was requested to unpublish in Video Cloud.
    
    Since:
    
    10.1.3
  - REMOVE_FROM_VIDEO_CLOUD
```
public static final AssetUsage REMOVE_FROM_VIDEO_CLOUD
```
    Asset was requested to remove from Video Cloud.
    
    Since:
    
    10.1.3
- Method Detail
  - values
```
public static AssetUsage[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (AssetUsage c : AssetUsage.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static AssetUsage valueOf(java.lang.String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    name - the name of the enum constant to be returned.
    
    Returns:
    the enum constant with the specified name
    
    Throws:
    
    java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
    
    java.lang.NullPointerException - if the argument is null
  - getUsageID
```
public int getUsageID()
```
    Returns the id of this usage.
    
    Returns:
    id
    See Also:
    findAssetUsage(int)
  - findAssetUsage
```
public static AssetUsage findAssetUsage(int id)
```
    Finds the usage for the given id.
    
    Parameters:
    id - id for the usage to find
    
    Returns:
    found usage or EnumConstantNotPresentException if the id cannot be found
    See Also:
    getUsageID()
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Enum<AssetUsage>

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.

Enum AssetUsage

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

PREVIEW

COPY_TO

MOVE_TO

MAIL_TO

PERFORM_ACTION

CONVERT

CREATE_SLIDE_SHOW

CREATE_WEB_ALBUM

CHECKOUT

CHECKIN

UNDO_CHECKOUT

TRANSFORM_ORIGINAL

SHOW_LOCATION

WRITE_METADATA_TO_ASSET

EDIT_WITH_APPLICATION

PRINT_WITH_APPLICATION

PRINT_USING_PRINT_SET

DOWNLOAD

COLLECT_FOR_CD

SHOW_ORIGINAL

UPDATE

UPDATE_ASSET_REFERENCE

COPY_TO_BACKUP

RESTORE_FROM_BACKUP

MOVE_TO_ARCHIVE

RESTORE_FROM_ARCHIVE

COMMENTED

UPLOAD_TO_VIDEO_CLOUD

PUBLISH_IN_VIDEO_CLOUD

UNPUBLISH_IN_VIDEO_CLOUD

REMOVE_FROM_VIDEO_CLOUD

Method Detail

values

valueOf

getUsageID

findAssetUsage

toString