Package com.day.cq.dam.scene7.api

Interface Scene7FlashTemplatesService

public interface Scene7FlashTemplatesService

The Scene7FlashTemplatesService provides a way to interact with flash templates (dynamic banners) served by the Scene7 service.

Field Summary

Fields

Modifier and Type	Field	Description
static String	FILE_REFERENCE
static String	FLASH_OUTPUT_TYPE
static String	MANUAL_MODIFIERS
static String	MODIFIERS
static String	OUTPUT_TYPE
static String	SCR_PROP_DEFAULT_REPLACE_BITMAP_INSTANCE
static String	SCR_PROP_DEFAULT_REPLACE_SYMBOL_INSTANCE
static String	SCR_PROP_DEFAULT_REPLACE_TEXT_INSTANCE
static String	SCR_PROP_DEFAULT_REPLACE_URLS
static String	SCR_PROP_DEFAULT_URL_FORMAT_PARAMETER
static String	SCR_PROP_NAME_REPLACE_BITMAP_INSTANCE
static String	SCR_PROP_NAME_REPLACE_SYMBOL_INSTANCE
static String	SCR_PROP_NAME_REPLACE_TEXT_INSTANCE
static String	SCR_PROP_NAME_REPLACE_URLS
static String	SCR_PROP_NAME_URL_FORMAT_PARAMETER

Method Summary

Modifier and Type	Method	Description
JSONObject	getFlashTemplateAssets(Resource resource, FlashTemplateAssetConstants assetType)	Queries the path to a Scene7 dynamic banner asset and retrieves the banner's assets as a JSON object.
String	getFlashTemplateModifyURL(Resource resource)	Given a Resource representing an abstractization of a flash template's elements, this method will return the URL needed for dynamically modifying the template using the S7 services.
boolean	renderAsHTML(Resource resource)	Based on a Resource abstractisation of a flash template will return true only if the selected rendering format is not Flash

Field Detail

MODIFIERS

static final String MODIFIERS

See Also:

Constant Field Values

FILE_REFERENCE

static final String FILE_REFERENCE

See Also:

Constant Field Values

MANUAL_MODIFIERS

static final String MANUAL_MODIFIERS

See Also:

Constant Field Values

OUTPUT_TYPE

static final String OUTPUT_TYPE

See Also:

Constant Field Values

FLASH_OUTPUT_TYPE

static final String FLASH_OUTPUT_TYPE

See Also:

Constant Field Values

SCR_PROP_NAME_URL_FORMAT_PARAMETER

static final String SCR_PROP_NAME_URL_FORMAT_PARAMETER

See Also:

Constant Field Values

SCR_PROP_DEFAULT_URL_FORMAT_PARAMETER

static final String SCR_PROP_DEFAULT_URL_FORMAT_PARAMETER

See Also:

Constant Field Values

SCR_PROP_NAME_REPLACE_TEXT_INSTANCE

static final String SCR_PROP_NAME_REPLACE_TEXT_INSTANCE

See Also:

Constant Field Values

SCR_PROP_DEFAULT_REPLACE_TEXT_INSTANCE

static final String SCR_PROP_DEFAULT_REPLACE_TEXT_INSTANCE

See Also:

Constant Field Values

SCR_PROP_NAME_REPLACE_SYMBOL_INSTANCE

static final String SCR_PROP_NAME_REPLACE_SYMBOL_INSTANCE

See Also:

Constant Field Values

SCR_PROP_DEFAULT_REPLACE_SYMBOL_INSTANCE

static final String SCR_PROP_DEFAULT_REPLACE_SYMBOL_INSTANCE

See Also:

Constant Field Values

SCR_PROP_NAME_REPLACE_BITMAP_INSTANCE

static final String SCR_PROP_NAME_REPLACE_BITMAP_INSTANCE

See Also:

Constant Field Values

SCR_PROP_DEFAULT_REPLACE_BITMAP_INSTANCE

static final String SCR_PROP_DEFAULT_REPLACE_BITMAP_INSTANCE

See Also:

Constant Field Values

SCR_PROP_NAME_REPLACE_URLS

static final String SCR_PROP_NAME_REPLACE_URLS

See Also:

Constant Field Values

SCR_PROP_DEFAULT_REPLACE_URLS

static final String SCR_PROP_DEFAULT_REPLACE_URLS

See Also:

Constant Field Values

Method Detail

getFlashTemplateAssets

JSONObject getFlashTemplateAssets(Resource resource,
                                  FlashTemplateAssetConstants assetType)

Queries the path to a Scene7 dynamic banner asset and retrieves the banner's assets as a JSON object.

Parameters:

resource - the resource identifying the dynamic banner

assetType - the asset type for which the JSON object should be built

Returns:

a JSON object containing the information about the banner's assets

getFlashTemplateModifyURL

String getFlashTemplateModifyURL(Resource resource)

Given a Resource representing an abstractization of a flash template's elements, this method will return the URL needed for dynamically modifying the template using the S7 services.

Parameters:

resource - the Resource representing the flash template

Returns:

the parametrised URL used for modifying the template

renderAsHTML

boolean renderAsHTML(Resource resource)

Based on a Resource abstractisation of a flash template will return true only if the selected rendering format is not Flash

Parameters:

resource - the Resource representing the flash template

Returns:

true if the rendering format is not Flash, false otherwise