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:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected booleanThis allows us to control whether the URL should / can be overwritten, for example by the static asset service.protected Stringprotected Characterprotected Longprotected Stringprotected Stringprotected StringFields inherited from class org.broadleafcommerce.common.rest.api.wrapper.BaseWrapper
context -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiongetId()getTags()getTitle()getUrl()booleanvoidsetAllowOverrideUrl(boolean allow) voidsetAltText(String altText) voidsetArchived(Character archived) voidvoidvoidvoidCall this only if allowOverrideUrl is true, and only AFTER you call wrap.voidwrapDetails(org.broadleafcommerce.common.media.domain.Media media, jakarta.servlet.http.HttpServletRequest request) voidwrapSummary(org.broadleafcommerce.common.media.domain.Media media, jakarta.servlet.http.HttpServletRequest request) Methods inherited from class org.broadleafcommerce.common.rest.api.wrapper.BaseWrapper
createElementWrappers, setApplicationContext, transferAdditionalFieldsFromWrapper
-
Field Details
-
allowOverrideUrl
protected boolean allowOverrideUrlThis allows us to control whether the URL should / can be overwritten, for example by the static asset service. -
id
-
title
-
url
-
altText
-
tags
-
archived
-
-
Constructor Details
-
MediaWrapper
public MediaWrapper()
-
-
Method Details
-
wrapDetails
public void wrapDetails(org.broadleafcommerce.common.media.domain.Media media, jakarta.servlet.http.HttpServletRequest request) - Specified by:
wrapDetailsin interfaceorg.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.common.media.domain.Media>
-
wrapSummary
public void wrapSummary(org.broadleafcommerce.common.media.domain.Media media, jakarta.servlet.http.HttpServletRequest request) - Specified by:
wrapSummaryin interfaceorg.broadleafcommerce.common.rest.api.wrapper.APIWrapper<org.broadleafcommerce.common.media.domain.Media>
-
isAllowOverrideUrl
public boolean isAllowOverrideUrl() -
setAllowOverrideUrl
public void setAllowOverrideUrl(boolean allow) -
getUrl
- Returns:
- the url
-
setUrl
Call this only if allowOverrideUrl is true, and only AFTER you call wrap.- Parameters:
url-
-
getId
- Returns:
- the id
-
setId
- Parameters:
id- the id to set
-
getTitle
- Returns:
- the title
-
setTitle
- Parameters:
title- the title to set
-
getAltText
- Returns:
- the altText
-
setAltText
- Parameters:
altText- the altText to set
-
getTags
- Returns:
- the tags
-
setTags
- Parameters:
tags- the tags to set
-
getArchived
-
setArchived
-