org.alfresco.wcm.client

Interface Asset

All Superinterfaces:

Resource, Serializable

All Known Subinterfaces:

SearchResult

All Known Implementing Classes:

AssetImpl, DeferredLoadingAssetImpl, SearchResultAssetImpl, SearchResultImpl

public interface Asset
extends Resource

Asset Interface

Author:

Roy Wetherall, Brian Remmington

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_AVERAGE_RATING
static String	PROPERTY_COMMENT_COUNT
static String	PROPERTY_PARENT_SECTIONS
static String	PROPERTY_PUBLISHED_TIME
static String	PROPERTY_TAGS Asset properties
static String	PROPERTY_TEMPLATE_NAME
static String	RELATED_PRIMARY_IMAGE Associations
static String	RELATED_SECONDARY_IMAGE

Fields inherited from interface org.alfresco.wcm.client.Resource

PROPERTY_AUTHOR, PROPERTY_DESCRIPTION, PROPERTY_MODIFIED_TIME, PROPERTY_TITLE

Method Summary

Methods

Modifier and Type	Method and Description
ContentStream	getContentAsInputStream() Gets the assets content input stream
String	getMimeType() Gets the mimetype of the asset.
Asset	getRelatedAsset(String relationshipName) Get a single related asset
Map<String,List<Asset>>	getRelatedAssets() Returns a Map of all the related assets.
List<Asset>	getRelatedAssets(String relationshipName) Get a list of related assets
Map<String,Rendition>	getRenditions() Get the renditions that are available for this asset.
long	getSize() Gets the size of the assets content.
List<String>	getTags() The asset tags
String	getTemplate() Gets the template associated with this asset, null if none.

Methods inherited from interface org.alfresco.wcm.client.Resource

getContainingSection, getDescription, getId, getName, getProperties, getProperty, getTitle, getType

Field Detail

PROPERTY_TAGS

static final String PROPERTY_TAGS

Asset properties

See Also:

Constant Field Values

PROPERTY_PARENT_SECTIONS

static final String PROPERTY_PARENT_SECTIONS

See Also:

Constant Field Values

PROPERTY_COMMENT_COUNT

static final String PROPERTY_COMMENT_COUNT

See Also:

Constant Field Values

PROPERTY_AVERAGE_RATING

static final String PROPERTY_AVERAGE_RATING

See Also:

Constant Field Values

PROPERTY_PUBLISHED_TIME

static final String PROPERTY_PUBLISHED_TIME

See Also:

Constant Field Values

PROPERTY_TEMPLATE_NAME

static final String PROPERTY_TEMPLATE_NAME

See Also:

Constant Field Values

RELATED_PRIMARY_IMAGE

static final String RELATED_PRIMARY_IMAGE

Associations

See Also:

Constant Field Values

RELATED_SECONDARY_IMAGE

static final String RELATED_SECONDARY_IMAGE

See Also:

Constant Field Values

Method Detail

getTags

List<String> getTags()

The asset tags

Returns:

Collection of tags

getMimeType

String getMimeType()

Gets the mimetype of the asset.

Returns:

String mimetype, null if none

getSize

long getSize()

Gets the size of the assets content.

Returns:

long content size

getContentAsInputStream

ContentStream getContentAsInputStream()

Gets the assets content input stream

Returns:

ContentStream assets content stream, null if none

getRelatedAsset

Asset getRelatedAsset(String relationshipName)

Get a single related asset

Parameters:

relationshipName -

Returns:

Asset - a related asset (null if none found)

getRelatedAssets

List<Asset> getRelatedAssets(String relationshipName)

Get a list of related assets

Parameters:

relationshipName -

Returns:

List - a list of related assets (empty if none found)

getRelatedAssets

Map<String,List<Asset>> getRelatedAssets()

Returns a Map of all the related assets.

Returns:

Map> Map of Assets lists keyed by relationship name (empty if none found)

getTemplate

String getTemplate()

Gets the template associated with this asset, null if none.

Returns:

String template associated with the asset, null if none.

getRenditions

Map<String,Rendition> getRenditions()

Get the renditions that are available for this asset.

Returns:

A map of available renditions keyed by rendition name