com.broadleafcommerce.rest.api.wrapper

Class MediaWrapper

java.lang.Object

org.broadleafcommerce.common.rest.api.wrapper.BaseWrapper

com.broadleafcommerce.rest.api.wrapper.MediaWrapper

All Implemented Interfaces:

Serializable, org.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.common.media.domain.Media>, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class MediaWrapper
extends org.broadleafcommerce.common.rest.api.wrapper.BaseWrapper
implements org.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.common.media.domain.Media>

JAXB wrapper class for Media.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowOverrideUrl This allows us to control whether the URL should / can be overwritten, for example by the static asset service.
protected String	altText
protected Character	archived
protected Long	id
protected String	tags
protected String	title
protected String	url

Fields inherited from class org.broadleafcommerce.common.rest.api.wrapper.BaseWrapper

context

Constructor Summary

Constructors

Constructor and Description
MediaWrapper()

Method Summary

Modifier and Type	Method and Description
String	getAltText()
Character	getArchived()
Long	getId()
String	getTags()
String	getTitle()
String	getUrl()
boolean	isAllowOverrideUrl()
void	setAllowOverrideUrl(boolean allow)
void	setAltText(String altText)
void	setArchived(Character archived)
void	setId(Long id)
void	setTags(String tags)
void	setTitle(String title)
void	setUrl(String url) Call this only if allowOverrideUrl is true, and only AFTER you call wrap.
void	wrapDetails(org.broadleafcommerce.common.media.domain.Media media, javax.servlet.http.HttpServletRequest request)
void	wrapSummary(org.broadleafcommerce.common.media.domain.Media media, javax.servlet.http.HttpServletRequest request)

Methods inherited from class org.broadleafcommerce.common.rest.api.wrapper.BaseWrapper

createElementWrappers, setApplicationContext, transferAdditionalFieldsFromWrapper

Methods inherited from class java.lang.Object

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

Field Detail

allowOverrideUrl

protected boolean allowOverrideUrl

This allows us to control whether the URL should / can be overwritten, for example by the static asset service.

id

protected Long id

title

protected String title

url

protected String url

altText

protected String altText

tags

protected String tags

archived

protected Character archived

Constructor Detail

MediaWrapper

public MediaWrapper()

Method Detail

wrapDetails

public void wrapDetails(org.broadleafcommerce.common.media.domain.Media media,
                        javax.servlet.http.HttpServletRequest request)

Specified by:

wrapDetails in interface org.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.common.media.domain.Media>

wrapSummary

public void wrapSummary(org.broadleafcommerce.common.media.domain.Media media,
                        javax.servlet.http.HttpServletRequest request)

Specified by:

wrapSummary in interface org.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.common.media.domain.Media>

isAllowOverrideUrl

public boolean isAllowOverrideUrl()

setAllowOverrideUrl

public void setAllowOverrideUrl(boolean allow)

getUrl

public String getUrl()

Returns:

the url

setUrl

public void setUrl(String url)

Call this only if allowOverrideUrl is true, and only AFTER you call wrap.

Parameters:

url -

getId

public Long getId()

Returns:

the id

setId

public void setId(Long id)

Parameters:

id - the id to set

getTitle

public String getTitle()

Returns:

the title

setTitle

public void setTitle(String title)

Parameters:

title - the title to set

getAltText

public String getAltText()

Returns:

the altText

setAltText

public void setAltText(String altText)

Parameters:

altText - the altText to set

getTags

public String getTags()

Returns:

the tags

setTags

public void setTags(String tags)

Parameters:

tags - the tags to set

getArchived

public Character getArchived()

setArchived

public void setArchived(Character archived)