com.fatwire.assetapi.fragment

Interface TemplateFragment<T extends TemplateFragment<T>>

Type Parameters:

T - type parameter for the template fragment implementation.

All Superinterfaces:

Fragment

All Known Subinterfaces:

EditableTemplateFragment<T>

@Exported
public interface TemplateFragment<T extends TemplateFragment<T>>
extends Fragment

Represents a fragment that invokes a template. To render an asset using a template, it is required to know:

• the asset (asset type and asset id) which is to be rendered.
• the template name using which the asset is to be rendered

Hence, a template fragment instance can be minimally built as:

TemplateFragment<?> fragment = FragmentFactory.newTemplateFragment()
                .useTemplate("/HomePage")
                .forAsset("MyAssetType", "1934567890")

If the asset is not specifically set into the fragment using TemplateFragment.forAsset(String, String), then it looks up the page context for c and cid. These variable names refer to the asset type and asset id respectively in the page context. If the template name is not specifically set into the fragment using TemplateFragment.useTemplate(String), then the default template is looked up for the asset set into the fragment. There are multiple ways arguments may be set into the fragment:

• as a name-value pair using TemplateFragment.addArgument(String, String)
• as a query string (of the form: name1=value1&name2=value2...) using TemplateFragment.setArguments(String)
• as a list of lookup argument names to be looked up from the page context, using TemplateFragment.useArguments(String, String...)

Nested Class Summary

Nested classes/interfaces inherited from interface com.fatwire.assetapi.fragment.Fragment

Fragment.Scope, Fragment.Style

Method Summary

Modifier and Type	Method and Description
T	addArgument(String name, String value) Adds a name-value pair as an argument.
T	forAsset(AssetId asset) Sets the asset type and id for the asset to be rendered by the template that this fragment invokes.
T	forAsset(String assetType, Long assetId) Sets the asset type and id for the asset to be rendered by the template that this fragment invokes.
T	forAsset(String assetType, String assetId) Sets the asset type and id for the asset to be rendered by the template that this fragment invokes.
T	inSite(String siteName) Sets the name of the site containing the template to be invoked.
T	invokeFrom(String id) Sets the id of the element from which this fragment is invoked.
T	resolveDevice(boolean resolve) Set to false to ignore the parameter 'd' and not try to re-direct to device group specific template.
T	setArguments(String arguments) Sets a query string containing URL-encoded name-value pairs.
T	useArguments(String variable, String... more) Sets Sites variables as arguments.
T	useDevice(String deviceSuffix) Sets a string that is the common suffix of all the templates written for a device group.
T	useStyle(Fragment.Style style) Sets whether the template invoked by this fragment should be invoked as an element or as a pagelet If invoked as a pagelet, it may be embedded in the parent for Satellite Server or should it be an independent pagelet.
T	useTemplate(String templateName) Sets the template name used by this fragment.

Method Detail

forAsset

T forAsset(String assetType,
           String assetId)

Sets the asset type and id for the asset to be rendered by the template that this fragment invokes.

Parameters:

assetType - the asset type

assetId - the asset id

Returns:

a handle to this builder

forAsset

T forAsset(String assetType,
           Long assetId)

Sets the asset type and id for the asset to be rendered by the template that this fragment invokes. This is a convenience method when the asset id is a long value.

Parameters:

assetType - the asset type

assetId - the asset id

Returns:

a handle to this builder

forAsset

T forAsset(AssetId asset)

Sets the asset type and id for the asset to be rendered by the template that this fragment invokes.

Parameters:

asset - the id of the asset for which this fragment should work.

Returns:

a handle to this builder

useTemplate

T useTemplate(String templateName)

Sets the template name used by this fragment. For typeless templates, the template name should be prefixed with a leading /.

Parameters:

templateName - the name of the template used by this fragment.

Returns:

a handle to this builder

useDevice

T useDevice(String deviceSuffix)

Sets a string that is the common suffix of all the templates written for a device group. If the suffix exists, the fragment will invoke the template variant for the specified suffix, otherwise will simply call the template by its name.

Parameters:

deviceSuffix - the device group suffix

Returns:

a handle to this builder

resolveDevice

T resolveDevice(boolean resolve)

Set to false to ignore the parameter 'd' and not try to re-direct to device group specific template. Default value: true.

Parameters:

resolve - the flag to dictate if the 'd' parameter will be ignored in resolving the template name.

Returns:

a handle to this builder

useStyle

T useStyle(Fragment.Style style)

Sets whether the template invoked by this fragment should be invoked as an element or as a pagelet If invoked as a pagelet, it may be embedded in the parent for Satellite Server or should it be an independent pagelet. Default value: Fragment.Style.PAGELET.

Parameters:

style - the invocation strategy.

Returns:

a handle to this builder

See Also:

Style

useArguments

T useArguments(String variable,
               String... more)

Sets Sites variables as arguments. If c and cid are set, then it is not necessary to set asset type and asset id using the TemplateFragment.forAsset(String, String) method. These will be looked up from the page context.

Parameters:

variable - a Site variable to add as argument

more - optional more Site variables to add as arguments

Returns:

a handle to this builder

setArguments

T setArguments(String arguments)

Sets a query string containing URL-encoded name-value pairs. The string is of the form: name1=value1&name2=value2...

Note: This method does not validate the above form of the string.

Parameters:

arguments - the URL encoded argument string to set

Returns:

a handle to this builder

inSite

T inSite(String siteName)

Sets the name of the site containing the template to be invoked. If this method is not invoked, the site name is looked up from the page context.

Parameters:

siteName - the name of the site

Returns:

a handle to this builder

invokeFrom

T invokeFrom(String id)

Sets the id of the element from which this fragment is invoked. If this method is not invoked, the id is looked up from the page context. For a Template, the tid variable provides this value. For a CSElement, the eid variable provides this value.

Parameters:

id - the id of the element from which this fragment is invoked.

Returns:

a handle to this builder

addArgument

T addArgument(String name,
              String value)

Adds a name-value pair as an argument.

Parameters:

name - the name for the argument

value - the value for the argument.

Returns:

a handle to this builder