Scene7Asset (The Adobe AEM Quickstart and Web Application.)

All Superinterfaces:: java.io.Serializable

@ProviderType
public interface Scene7Asset
extends java.io.Serializable

Abstraction of a Scene7 Asset

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addSubAsset(Scene7Asset subAsset)` Adds a new sub-asset to the current asset
`java.lang.String`	`getAssetHandle()` Get this asset handle
`java.util.Map<java.lang.String,java.lang.String>`	`getAssetProperties()`
`java.lang.String`	`getAssetSubTypeStr()` Get the asset's subtype string from Scene7 (if appliable)
`Scene7AssetType`	`getAssetType()` Get the type of this asset
`java.lang.String`	`getAssetTypeStr()` Get the asset type as read from Scene7
`java.lang.String`	`getCreatedBy()` Get the user that created this asset
`java.util.Date`	`getCreatedDate()` Get the creation date of this asset
`java.lang.String`	`getFileName()` Get the file name where the asset is stored
`java.lang.Integer`	`getFileSize()` Gets the size in bytes of the file where the asset is stored
`java.lang.String`	`getFolder()` Get the folder where this asset is stored
`java.lang.String`	`getFolderHandle()` Get the Scene7 folder handle of the folder containing this asset
`java.lang.Long`	`getHeight()` Get the height of this asset
`java.lang.String`	`getIpsImageUrl()` Get the ips url for this asset
`java.lang.String`	`getModifiedBy()` Get the user that last modified this asset
`java.util.Date`	`getModifiedDate()` Get the last modified date of this asset
`java.lang.String`	`getName()` Get the name of this asset
`java.lang.String`	`getOriginalFile()` Get the original file uploaded to Scene7 for this asset
`java.lang.String`	`getOriginalPath()` Get the original path of the file uploaded to Scene7 for this asset
`Scene7Asset`	`getOriginatorAsset()` Gets the originator asset for this asset Should only return a valid asset if the current asset was generated from another uploaded asset (e.g.
`java.lang.String`	`getRootFolder()` Returns the root folder or an empty `String` if no folder is specified for this asset.
`Scene7SmartCrop`	`getSmartCrop()` Gets the `Scene7SmartCrop` object (if exists) associated with this asset
`java.util.List<Scene7Asset>`	`getSubAssets()` Get the list of this asset's sub-assets
`java.lang.String`	`getUrlModifier()` Get the url modified of this asset
`java.lang.String`	`getVideoEncodingPresetId()` Gets the video encoding preset id for this asset, if this is a video scene7 asset
`java.util.Map<java.lang.String,java.lang.String>`	`getVideoProperties()` Returns a map with video properties such as duration, bit rate of the asset if its a video, null otherwise
`java.util.Map<java.lang.String,java.lang.String>`	`getViewerPresetConfigurationSettings()` Get a map containing the viewer preset configuration for this asset
`java.lang.String`	`getViewerPresetType()` Get the viewer preset type of this asset
`java.lang.Long`	`getWidth()` Get the width of this asset
`boolean`	`isPublished()` Gets the publish status of this asset
`void`	`updateOriginatorAsset(Scene7Asset originator)` Updates the originator asset of the current asset

- Method Detail
  - getAssetType
```
Scene7AssetType getAssetType()
```
    Get the type of this asset
    
    Returns:
    
    A Scene7AssetType identifying this asset type
  - getAssetTypeStr
```
java.lang.String getAssetTypeStr()
```
    Get the asset type as read from Scene7
    
    Returns:
    
    A String object containing the actual Scene7 type string
  - getAssetSubTypeStr
```
java.lang.String getAssetSubTypeStr()
```
    Get the asset's subtype string from Scene7 (if appliable)
    
    Returns:
    
    A String object containing the Scene7 subtype string
  - getName
```
java.lang.String getName()
```
    Get the name of this asset
    
    Returns:
    
    String object containing the asset's name
  - getAssetHandle
```
java.lang.String getAssetHandle()
```
    Get this asset handle
    
    Returns:
    
    String object with this asset's handle
  - getFileName
```
java.lang.String getFileName()
```
    Get the file name where the asset is stored
    
    Returns:
    
    String containing the file name of the asset
  - getFolder
```
java.lang.String getFolder()
```
    Get the folder where this asset is stored
    
    Returns:
    
    String containing the folder path of the asset
  - getFolderHandle
```
java.lang.String getFolderHandle()
```
    Get the Scene7 folder handle of the folder containing this asset
    
    Returns:
    
    String object containing a Scene7 folder handle
  - getCreatedBy
```
java.lang.String getCreatedBy()
```
    Get the user that created this asset
    
    Returns:
    
    String object containing the username of the user that created this asset
  - getModifiedBy
```
java.lang.String getModifiedBy()
```
    Get the user that last modified this asset
    
    Returns:
    
    String object containing the username of the user that last modified this asset
  - getCreatedDate
```
java.util.Date getCreatedDate()
```
    Get the creation date of this asset
    
    Returns:
    
    Date object with the creation time of the asset
  - getModifiedDate
```
java.util.Date getModifiedDate()
```
    Get the last modified date of this asset
    
    Returns:
    
    Date object with the time the asset was last modified
  - getOriginalFile
```
java.lang.String getOriginalFile()
```
    Get the original file uploaded to Scene7 for this asset
    
    Returns:
    
    String object containing the original file of this asset
  - getOriginalPath
```
java.lang.String getOriginalPath()
```
    Get the original path of the file uploaded to Scene7 for this asset
    
    Returns:
    
    String object containing the original path for this asset
  - getIpsImageUrl
```
java.lang.String getIpsImageUrl()
```
    Get the ips url for this asset
    
    Returns:
    
    String object containing the ips url for this asset
  - getSubAssets
```
java.util.List<Scene7Asset> getSubAssets()
```
    Get the list of this asset's sub-assets
    
    Returns:
    
    a List with the Scene7Asset assets linked to this asset
  - addSubAsset
```
void addSubAsset(Scene7Asset subAsset)
```
    Adds a new sub-asset to the current asset
    
    Parameters:
    
    subAsset - a Scene7Asset object to be added as a sub-asset of the current asset
  - getOriginatorAsset
```
Scene7Asset getOriginatorAsset()
```
    Gets the originator asset for this asset Should only return a valid asset if the current asset was generated from another uploaded asset (e.g. a Template asset is usually generated after importing a PSD into Scene7; the original uploaded PSD will be the Template asset's originator)
    
    Returns:
    
    a Scene7Asset object holding this asset's originator asset
  - updateOriginatorAsset
```
void updateOriginatorAsset(Scene7Asset originator)
```
    Updates the originator asset of the current asset
    
    Parameters:
    
    originator - the new Scene7Asset originator of the current asset
  - getWidth
```
java.lang.Long getWidth()
```
    Get the width of this asset
    
    Returns:
    
    a Long object containing the width of this asset
  - getHeight
```
java.lang.Long getHeight()
```
    Get the height of this asset
    
    Returns:
    
    a Long object containing the height of this asset
  - getUrlModifier
```
java.lang.String getUrlModifier()
```
    Get the url modified of this asset
    
    Returns:
    
    a String object containing the url modifier of this asset
  - getViewerPresetType
```
java.lang.String getViewerPresetType()
```
    Get the viewer preset type of this asset
    
    Returns:
    
    a String object containing the viewer preset type
  - getViewerPresetConfigurationSettings
```
java.util.Map<java.lang.String,java.lang.String> getViewerPresetConfigurationSettings()
```
    Get a map containing the viewer preset configuration for this asset
    
    Returns:
    
    a Map that store the name-value pairs found in the viewer preset configuration of the asset
  - getRootFolder
```
java.lang.String getRootFolder()
```
    Returns the root folder or an empty String if no folder is specified for this asset.
    
    Returns:
    
    path to Root folder
  - isPublished
```
boolean isPublished()
```
    Gets the publish status of this asset
    
    Returns:
    
    a Boolean indicating if this asset is published or not
  - getFileSize
```
java.lang.Integer getFileSize()
```
    Gets the size in bytes of the file where the asset is stored
    
    Returns:
    
    an Integer containing the file size
  - getVideoEncodingPresetId
```
java.lang.String getVideoEncodingPresetId()
```
    Gets the video encoding preset id for this asset, if this is a video scene7 asset
    
    Returns:
    
    a String containing the video encoding preset for a video scene7 asset
  - getAssetProperties
```
java.util.Map<java.lang.String,java.lang.String> getAssetProperties()
```
  - getSmartCrop
```
Scene7SmartCrop getSmartCrop()
```
    Gets the Scene7SmartCrop object (if exists) associated with this asset
    
    Returns:
    
    Scene7SmartCrop object
  - getVideoProperties
```
java.util.Map<java.lang.String,java.lang.String> getVideoProperties()
```
    Returns a map with video properties such as duration, bit rate of the asset if its a video, null otherwise
    
    Returns:
    
    a java.util.Map

Interface Scene7Asset

Method Summary

Method Detail

getAssetType

getAssetTypeStr

getAssetSubTypeStr

getName

getAssetHandle

getFileName

getFolder

getFolderHandle

getCreatedBy

getModifiedBy

getCreatedDate

getModifiedDate

getOriginalFile

getOriginalPath

getIpsImageUrl

getSubAssets

addSubAsset

getOriginatorAsset

updateOriginatorAsset

getWidth

getHeight

getUrlModifier

getViewerPresetType

getViewerPresetConfigurationSettings

getRootFolder

isPublished

getFileSize

getVideoEncodingPresetId

getAssetProperties

getSmartCrop

getVideoProperties