com.fatwire.gst.foundation.include

Interface IncludeService

All Known Implementing Classes:

DefaultIncludeService

public interface IncludeService

Service to include Templates, SiteEntries and CSElements.

Since:

Apr 13, 2011

Author:

Dolf Dijkstra

Method Summary

Methods

Modifier and Type	Method and Description
IncludeElement	element(String name, String elementname) Creates a IncludeElement and registers this under the name for retrieval in the View layer by that name.
IncludePage	page(String name, String pagename, CallTemplate.Style style) Creates a IncludePage and registers this under the name for retrieval in the View layer by that name.
IncludeTemplate	template(String name, com.fatwire.assetapi.data.AssetId asset, String tname) Creates a IncludeTemplate and registers this under the name for retrieval in the View layer by that name.

Method Detail

template

IncludeTemplate template(String name,
                       com.fatwire.assetapi.data.AssetId asset,
                       String tname)

Creates a IncludeTemplate and registers this under the name for retrieval in the View layer by that name.

Parameters:

name - the name of the Include for reference in the View layer

asset - the asset to render.

tname - the template name.

Returns:

the created IncludeTemplate

page

IncludePage page(String name,
               String pagename,
               CallTemplate.Style style)

Creates a IncludePage and registers this under the name for retrieval in the View layer by that name.

Parameters:

name - the name of the Include for reference in the View layer.

pagename - the name of the SiteCatalog entry to call.

style -

Returns:

the created IncludePage

element

IncludeElement element(String name,
                     String elementname)

Creates a IncludeElement and registers this under the name for retrieval in the View layer by that name.

Parameters:

name - the name of the Include for reference in the View layer.

elementname - the name of the element to call.

Returns:

the created IncludeElement