org.broadleafcommerce.cms.file.domain

Class StaticAssetImpl

java.lang.Object

org.broadleafcommerce.cms.file.domain.StaticAssetImpl

All Implemented Interfaces:

Serializable, StaticAsset, AdminMainEntity, MultiTenantCloneable<StaticAsset>

Direct Known Subclasses:

ImageStaticAssetImpl

@Entity
public class StaticAssetImpl
extends Object
implements StaticAsset, AdminMainEntity

Created by bpolster.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StaticAssetImpl.Presentation

Field Summary

Fields

Modifier and Type	Field and Description
protected String	altText
protected AdminAuditable	auditable
protected Map<String,StaticAssetDescription>	contentMessageValues
protected String	fileExtension
protected Long	fileSize
protected String	fullUrl
protected Long	id
protected String	mimeType
protected String	name
protected String	storageType
protected String	title

Fields inherited from interface org.broadleafcommerce.common.admin.domain.AdminMainEntity

MAIN_ENTITY_NAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
StaticAssetImpl()

Method Summary

Methods

Modifier and Type	Method and Description
<G extends StaticAsset> CreateResponse<G>	createOrRetrieveCopyInstance(MultiTenantCopyContext context) Clone this entity for the purpose of multiple tenancy.
String	getAltText() Returns the altText of this asset.
AdminAuditable	getAuditable()
Map<String,StaticAssetDescription>	getContentMessageValues()
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.
String	getMainEntityName()
String	getMimeType() Returns the mimeType of the asset.
String	getName() The name of the static asset.
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	setAuditable(AdminAuditable auditable)
void	setContentMessageValues(Map<String,StaticAssetDescription> contentMessageValues)
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	setMimeType(String mimeType) Sets the mimeType of the asset.
void	setName(String name) Sets the name of the static asset.
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.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

auditable

protected AdminAuditable auditable

name

protected String name

fullUrl

protected String fullUrl

title

protected String title

altText

protected String altText

mimeType

protected String mimeType

fileSize

protected Long fileSize

fileExtension

protected String fileExtension

contentMessageValues

protected Map<String,StaticAssetDescription> contentMessageValues

storageType

protected String storageType

Constructor Detail

StaticAssetImpl

public StaticAssetImpl()

Method Detail

getFullUrl

public String getFullUrl()

Description copied from interface: StaticAsset

URL used to retrieve this asset.

Specified by:

getFullUrl in interface StaticAsset

Returns:

setFullUrl

public void setFullUrl(String fullUrl)

Description copied from interface: StaticAsset

Sets the URL for the asset

Specified by:

setFullUrl in interface StaticAsset

getTitle

public String getTitle()

Description copied from interface: StaticAsset

Returns the title of this asset.

Specified by:

getTitle in interface StaticAsset

Returns:

setTitle

public void setTitle(String title)

Description copied from interface: StaticAsset

Set the title of the static asset.

Specified by:

setTitle in interface StaticAsset

getAltText

public String getAltText()

Description copied from interface: StaticAsset

Returns the altText of this asset.

Specified by:

getAltText in interface StaticAsset

Returns:

setAltText

public void setAltText(String altText)

Description copied from interface: StaticAsset

Set the altText of the static asset.

Specified by:

setAltText in interface StaticAsset

getFileSize

public Long getFileSize()

Description copied from interface: StaticAsset

Filesize of the asset.

Specified by:

getFileSize in interface StaticAsset

Returns:

setFileSize

public void setFileSize(Long fileSize)

Description copied from interface: StaticAsset

Sets the filesize of the asset

Specified by:

setFileSize in interface StaticAsset

getContentMessageValues

public Map<String,StaticAssetDescription> getContentMessageValues()

Specified by:

getContentMessageValues in interface StaticAsset

Returns:

setContentMessageValues

public void setContentMessageValues(Map<String,StaticAssetDescription> contentMessageValues)

Specified by:

setContentMessageValues in interface StaticAsset

getMimeType

public String getMimeType()

Description copied from interface: StaticAsset

Returns the mimeType of the asset.

Specified by:

getMimeType in interface StaticAsset

Returns:

setMimeType

public void setMimeType(String mimeType)

Description copied from interface: StaticAsset

Sets the mimeType of the asset.

Specified by:

setMimeType in interface StaticAsset

getFileExtension

public String getFileExtension()

Description copied from interface: StaticAsset

Returns the file extension of the asset.

Specified by:

getFileExtension in interface StaticAsset

Returns:

setFileExtension

public void setFileExtension(String fileExtension)

Description copied from interface: StaticAsset

Sets the fileExtension of the asset.

Specified by:

setFileExtension in interface StaticAsset

getAuditable

public AdminAuditable getAuditable()

Specified by:

getAuditable in interface StaticAsset

setAuditable

public void setAuditable(AdminAuditable auditable)

Specified by:

setAuditable in interface StaticAsset

getId

public Long getId()

Description copied from interface: StaticAsset

Returns the id of the static asset.

Specified by:

getId in interface StaticAsset

Returns:

setId

public void setId(Long id)

Description copied from interface: StaticAsset

Sets the id of the static asset.

Specified by:

setId in interface StaticAsset

getName

public String getName()

Description copied from interface: StaticAsset

The name of the static asset.

Specified by:

getName in interface StaticAsset

Returns:

setName

public void setName(String name)

Description copied from interface: StaticAsset

Sets the name of the static asset. Used primarily for

Specified by:

setName in interface StaticAsset

getStorageType

public StorageType getStorageType()

Description copied from interface: StaticAsset

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

Specified by:

getStorageType in interface StaticAsset

Returns:

See Also:

StaticAssetService}

setStorageType

public void setStorageType(StorageType storageType)

Description copied from interface: StaticAsset

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

Specified by:

setStorageType in interface StaticAsset

createOrRetrieveCopyInstance

public <G extends StaticAsset> CreateResponse<G> createOrRetrieveCopyInstance(MultiTenantCopyContext context)
                                                                   throws CloneNotSupportedException

Description copied from interface: MultiTenantCloneable

Clone this entity for the purpose of multiple tenancy. Note, extending classes should follow this pattern:

public CreateResponse<MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse<MyClass> createResponse = super.createOrRetrieveCopyInstance(context); if (createResponse.isAlreadyPopulated()) { return createResponse; } MyClass myClone = createResponse.getClone(); //copy extended field values on myClone here return createResponse; }

Support should also be added for @Embeddable classes that contribute fields (collections or basic) to a cloneable entity:

public CreateResponse<G extends MyClass> createOrRetrieveCopyInstance(MultiTenantCopyContext context) throws CloneNotSupportedException { CreateResponse createResponse = context.createOrRetrieveCopyInstance(this); MyClass myClone = createResponse.getClone(); //copy extended field values on myClone here return createResponse; }

Specified by:

createOrRetrieveCopyInstance in interface MultiTenantCloneable<StaticAsset>

Parameters:

context - a context object providing persistence and library functionality for copying entities

Returns:

the resulting copy container, possibly already persisted

Throws:

CloneNotSupportedException - if there's a problem detected with the cloning configuration

getMainEntityName

public String getMainEntityName()

Specified by:

getMainEntityName in interface AdminMainEntity

Returns:

the display name of this entity for the admin screen