de.hybris.platform.mediaconversion.web.facades

Interface OnDemandConversionFacade

All Known Implementing Classes:

DefaultOnDemandConversionFacade

public interface OnDemandConversionFacade

Facade to handle requests from the integrated taglib and servlet.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BEAN_NAME Spring bean id of this service's implementation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	convert(MediaContainerModel container, ConversionMediaFormatModel format)
java.lang.String	convert(MediaContainerModel container, java.lang.String format)
java.lang.String	convert(PK container, java.lang.String format)
java.lang.String	retrieveURL(MediaContainerModel container, ConversionMediaFormatModel format)
java.lang.String	retrieveURL(MediaContainerModel container, java.lang.String format)

Field Detail

BEAN_NAME

static final java.lang.String BEAN_NAME

Spring bean id of this service's implementation.

See Also:

Constant Field Values

Method Detail

convert

java.lang.String convert(PK container,
                         java.lang.String format)
                  throws ModelLoadingException,
                         UnknownIdentifierException

Parameters:

container - the MediaContainerModel's PK in question

format - the qualifier of the ConversionMediaFormatModel to convert to.

Returns:

the URL to the requested Media.

Throws:

ModelLoadingException - if the model for the given PK could not be found or is not a MediaContainerModel.

UnknownIdentifierException - if no corresponding ConversionMediaFormatModel for the given format qualifier could be found.

retrieveURL

java.lang.String retrieveURL(MediaContainerModel container,
                             java.lang.String format)
                      throws UnknownIdentifierException

Parameters:

container - the MediaContainerModel in question

format - the qualifier of the ConversionMediaFormatModel to convert to or null (or the empty string) to retrieve the container's master media url.

Returns:

the URL to the requested Media.

Throws:

UnknownIdentifierException - if no corresponding ConversionMediaFormatModel for the given non-empty, non-null format qualifier could be found.

retrieveURL

java.lang.String retrieveURL(MediaContainerModel container,
                             ConversionMediaFormatModel format)

Parameters:

container - the MediaContainerModel in question

format - the qualifier of the ConversionMediaFormatModel to convert to or null (or the empty string) to retrieve the container's master media url.

Returns:

the URL to the requested Media

convert

java.lang.String convert(MediaContainerModel container,
                         ConversionMediaFormatModel format)

Parameters:

container - the MediaContainerModel in question

format - the ConversionMediaFormatModel to convert to or null (or the empty string) to retrieve the container's master media url.

Returns:

the URL to the requested Media

convert

java.lang.String convert(MediaContainerModel container,
                         java.lang.String format)

Parameters:

container - the MediaContainerModel in question

format - the qualifier of the ConversionMediaFormatModel to convert to or null (or the empty string) to retrieve the container's master media url.

Returns:

the URL to the requested Media