org.broadleafcommerce.cms.file.domain

Interface StaticAsset

All Superinterfaces:

Serializable

All Known Subinterfaces:

ImageStaticAsset

All Known Implementing Classes:

ImageStaticAssetImpl, StaticAssetImpl

public interface StaticAsset
extends Serializable

Created by bpolster.

Method Summary

Methods

Modifier and Type	Method and Description
StaticAsset	cloneEntity()
String	getAltText() Returns the altText of this asset.
Boolean	getArchivedFlag()
AdminAuditable	getAuditable()
Map<String,StaticAssetDescription>	getContentMessageValues() Deprecated. - Use getTitle() or getAltText()getAltText() instead.
Boolean	getDeletedFlag()
String	getFileExtension() Returns the file extension of the asset.
Long	getFileSize() Filesize of the asset.
String	getFullUrl() URL used to retrieve this asset.
Long	getId() Returns the id of the static asset.
Boolean	getLockedFlag()
String	getMimeType() Returns the mimeType of the asset.
String	getName() The name of the static asset.
Long	getOriginalAssetId()
SandBox	getOriginalSandBox()
SandBox	getSandbox()
Site	getSite() Deprecated. - not currently used
StorageType	getStorageType() Returns how the underlying asset is stored.
String	getTitle() Returns the title of this asset.
void	setAltText(String altText) Set the altText of the static asset.
void	setArchivedFlag(Boolean archivedFlag)
void	setAuditable(AdminAuditable auditable)
void	setContentMessageValues(Map<String,StaticAssetDescription> contentMessageValues) Deprecated. - Use setTitle(String) or setAltText(String) instead.
void	setDeletedFlag(Boolean deletedFlag)
void	setFileExtension(String fileExtension) Sets the fileExtension of the asset.
void	setFileSize(Long fileSize) Sets the filesize of the asset
void	setFullUrl(String fullUrl) Sets the URL for the asset
void	setId(Long id) Sets the id of the static asset.
void	setLockedFlag(Boolean lockedFlag)
void	setMimeType(String mimeType) Sets the mimeType of the asset.
void	setName(String name) Sets the name of the static asset.
void	setOriginalAssetId(Long originalPageId)
void	setOriginalSandBox(SandBox originalSandBox)
void	setSandbox(SandBox sandbox)
void	setSite(Site site) Deprecated. - not currently used
void	setStorageType(StorageType storageType) Returns how the asset was stored in the backend (e.g.
void	setTitle(String title) Set the title of the static asset.

Method Detail

getId

Long getId()

Returns the id of the static asset.

Returns:

setId

void setId(Long id)

Sets the id of the static asset.

Parameters:

id -

getName

String getName()

The name of the static asset.

Returns:

setName

void setName(String name)

Sets the name of the static asset. Used primarily for

Parameters:

name -

getAltText

String getAltText()

Returns the altText of this asset.

Returns:

setAltText

void setAltText(String altText)

Set the altText of the static asset.

Parameters:

title -

getTitle

String getTitle()

Returns the title of this asset.

Returns:

setTitle

void setTitle(String title)

Set the title of the static asset.

Parameters:

title -

getFullUrl

String getFullUrl()

URL used to retrieve this asset.

Returns:

setFullUrl

void setFullUrl(String fullUrl)

Sets the URL for the asset

Parameters:

fullUrl -

getFileSize

Long getFileSize()

Filesize of the asset.

Returns:

setFileSize

void setFileSize(Long fileSize)

Sets the filesize of the asset

Parameters:

fileSize -

getContentMessageValues

Map<String,StaticAssetDescription> getContentMessageValues()

Deprecated. - Use getTitle() or getAltText()getAltText() instead.

Returns:

setContentMessageValues

void setContentMessageValues(Map<String,StaticAssetDescription> contentMessageValues)

Deprecated. - Use setTitle(String) or setAltText(String) instead.

Parameters:

contentMessageValues -

getMimeType

String getMimeType()

Returns the mimeType of the asset.

Returns:

setMimeType

void setMimeType(String mimeType)

Sets the mimeType of the asset.

getFileExtension

String getFileExtension()

Returns the file extension of the asset.

Returns:

setFileExtension

void setFileExtension(String fileExtension)

Sets the fileExtension of the asset.

Parameters:

fileExtension -

getStorageType

StorageType getStorageType()

Returns how the underlying asset is stored. Typically on the FileSystem or the Database. If null, this method returns StorageType.DATABASE for backwards compatibility.

Returns:

See Also:

StaticAssetService}

setStorageType

void setStorageType(StorageType storageType)

Returns how the asset was stored in the backend (e.g. DATABASE or FILESYSTEM)

Parameters:

storageType -

getSite

Site getSite()

Deprecated. - not currently used

Returns:

setSite

void setSite(Site site)

Deprecated. - not currently used

Parameters:

site -

getOriginalSandBox

SandBox getOriginalSandBox()

setOriginalSandBox

void setOriginalSandBox(SandBox originalSandBox)

getAuditable

AdminAuditable getAuditable()

setAuditable

void setAuditable(AdminAuditable auditable)

getLockedFlag

Boolean getLockedFlag()

setLockedFlag

void setLockedFlag(Boolean lockedFlag)

getDeletedFlag

Boolean getDeletedFlag()

setDeletedFlag

void setDeletedFlag(Boolean deletedFlag)

getArchivedFlag

Boolean getArchivedFlag()

setArchivedFlag

void setArchivedFlag(Boolean archivedFlag)

getOriginalAssetId

Long getOriginalAssetId()

setOriginalAssetId

void setOriginalAssetId(Long originalPageId)

getSandbox

SandBox getSandbox()

setSandbox

void setSandbox(SandBox sandbox)

cloneEntity

StaticAsset cloneEntity()