com.fatwire.assetapi.data

Interface LinkInfo<T extends LinkInfo>

All Known Subinterfaces:

LegacyLinkInfo<E>

public interface LinkInfo<T extends LinkInfo>

Method Summary

Modifier and Type	Method and Description
T	forAsset(AssetId id) Specify the AssetId that this LinkInfo is used for
T	forDevice(String deviceSuffix) specify the Device Group Suffix(a string that is common suffix of all the templates written for current device group).
T	forSite(String siteName) Specify the sitename that is going to be used
T	forType(String type) Specify the type that this LinkInfo is used for.
T	forType(String type, String subtype) Specify the type and subtype that this LinkInfo is used for.
AssetId	getAssetId()
String	getDevice()
Map<String,String>	getParameters()
String	getSite()
String	getSubtype()
String	getTemplate()
String	getType()
String	getWebroot()
T	parameters(Map<String,String> parameters) The map of parameters that will be used to generate the link
T	useTemplate(String template) The name of the Template to be called
T	useWebroot(String webrootName) Specify the name of WebRoot to be used for retrieving vanity URL.

Method Detail

forAsset

T forAsset(AssetId id)

Specify the AssetId that this LinkInfo is used for

Parameters:

id - the AssetId

Returns:

a LinkInfo

forType

T forType(String type)

Specify the type that this LinkInfo is used for. Note, this method resets the type set by forType(String, String)

Parameters:

type - the asset type

Returns:

a LinkInfo

forType

T forType(String type,
          String subtype)

Specify the type and subtype that this LinkInfo is used for. Note, this method resets the type set by forType(String)

Parameters:

type - the asset type

subtype - the asset subtype

Returns:

a LinkInfo

useTemplate

T useTemplate(String template)

The name of the Template to be called

Parameters:

template - the name of the template

Returns:

a LinkInfo

parameters

T parameters(Map<String,String> parameters)

The map of parameters that will be used to generate the link

Parameters:

parameters - the map of parameters

Returns:

a LinkInfo

forDevice

T forDevice(String deviceSuffix)

specify the Device Group Suffix(a string that is common suffix of all the templates written for current device group). For example, if d ='Touch' and parameter tname = 'HomeLayout', the tag will try to find a template with name tname_d i.e. HomeLayout_Touch. If it exists, the tag will return the url of this template, otherwise will simply return the url of the template 'HomeLayout' i.e. actual tname provided.

Parameters:

deviceSuffix - the Device Group Suffix

Returns:

a LinkInfo

useWebroot

T useWebroot(String webrootName)

Specify the name of WebRoot to be used for retrieving vanity URL.

Parameters:

webrootName - the name of the webroot

Returns:

a LinkInfo

forSite

T forSite(String siteName)

Specify the sitename that is going to be used

Parameters:

siteName - the site name

Returns:

a LinkInfo

getAssetId

AssetId getAssetId()

getType

String getType()

getSubtype

String getSubtype()

getTemplate

String getTemplate()

getParameters

Map<String,String> getParameters()

getDevice

String getDevice()

getSite

String getSite()

getWebroot

String getWebroot()