com.canto.cumulus.fieldvalue

Class AssetReferencePart

java.lang.Object

com.canto.cumulus.fieldvalue.AssetReferencePart

public class AssetReferencePart
extends java.lang.Object

This class represents a part of an AssetReference field value.

Since:

8.0

Method Summary

Methods

Modifier and Type	Method and Description
GUID	getAssetStorageUID() Get the class ID of the asset storage module that generated this part.
byte[]	getBinaryData() Get the binary data for this asset reference part.
CumulusSession	getCumulusSession() Returns the current CumulusSession object.
java.lang.String	getDisplayString() Get a user-readable string for the binary data of this asset reference part.
int	getLevel() Get the level of this asset reference part inside the surrounding asset reference object.
java.lang.String	getName() Get the name of the asset storage module responsible for this asset reference part.
void	setBinaryData(byte[] data) Set the binary data for this asset reference part.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getCumulusSession

public CumulusSession getCumulusSession()

Returns the current CumulusSession object.

Returns:

the current CumulusSession object

getAssetStorageUID

public GUID getAssetStorageUID()

Get the class ID of the asset storage module that generated this part. Typically this is one of the following constants:

• GUID.UID_AS_WIN_FILE
• GUID.UID_AS_MAC_FILE
• GUID.UID_AS_UNIX_FILE
• GUID.UID_AS_URL
• GUID.UID_AS_VAULT
• GUID.UID_AS_ZIP

Returns:

The module class ID of the asset storage module responsible for this asset reference part.

getBinaryData

public byte[] getBinaryData()

Get the binary data for this asset reference part. The asset storage module defines the format of this data. For Canto asset storage modules this is a JPack format but third-party asset storage modules may use a different format to store their data.

Returns:

The binary data of this asset reference part.

setBinaryData

public void setBinaryData(byte[] data)

Set the binary data for this asset reference part. The asset storage module defines the format of this data. For Canto asset storage modules this is a JPack format but third-party asset storage modules may use a different format to store their data.

Parameters:

data - The binary data for this asset reference part.

getLevel

public int getLevel()

Get the level of this asset reference part inside the surrounding asset reference object. Top-level parts have the level of 0 and are resolved first when resolving the asset reference.

Returns:

The level of this part inside the surrounding asset reference object.

getName

public java.lang.String getName()

Get the name of the asset storage module responsible for this asset reference part.

Returns:

The asset storage module's name of this part.
Typical values are:

• "Windows"
• "Mac OS"
• "Unix"
• "URL"
• "Vault"
• "ZIP"

getDisplayString

public java.lang.String getDisplayString()

Get a user-readable string for the binary data of this asset reference part. The creating asset storage module is asked to return a display string so it is required to be installed for this method to be successful.

Returns:

A user-readable string of the binary data of this asset reference part.