com.fatwire.gst.foundation.facade.runtag.render
Class CallTemplate

java.lang.Object
  extended by com.fatwire.gst.foundation.facade.FTValListFacade
      extended by com.fatwire.gst.foundation.facade.runtag.AbstractTagRunner
          extended by com.fatwire.gst.foundation.facade.runtag.render.TagRunnerWithArguments
              extended by com.fatwire.gst.foundation.facade.runtag.render.TagRunnerWithRenderArguments
                  extended by com.fatwire.gst.foundation.facade.runtag.render.CallTemplate
All Implemented Interfaces:
TagRunner

public class CallTemplate
extends TagRunnerWithRenderArguments

CallTemplate tag with many improvements around context and style.

<RENDER.CALLTEMPLATE SITE="site name" SLOTNAME="name of slot" TID="caller Template or CSElement id" [TTYPE="caller Template or CSElement"] [C="asset type"] [CID="asset id"] [TNAME="target Template or CSElement name"] [CONTEXT="context override"] [STYLE="pagelet or element"] [VARIANT="template variant name"] [PACKEDARGS="packed arguments"]>

[<RENDER.ARGUMENT NAME="variable1" VALUE="value1"/>]

</RENDER.CALLTEMPLATE>

Since:
Jun 10, 2010
Author:
Tony Field, Dolf Dijkstra

Nested Class Summary
static class CallTemplate.Style
           
static class CallTemplate.Type
           
 
Field Summary
protected static List<String> CALLTEMPLATE_EXCLUDE_VARS
           
 
Fields inherited from class com.fatwire.gst.foundation.facade.runtag.render.TagRunnerWithRenderArguments
ARGS
 
Fields inherited from class com.fatwire.gst.foundation.facade.FTValListFacade
list
 
Constructor Summary
CallTemplate()
           
CallTemplate(String slotname, String tname, CallTemplate.Type type)
          Sets up CallTemplate with default Style.element
 
Method Summary
protected  void handleError(COM.FutureTense.Interfaces.ICS ics)
          default error handling method.
 boolean isFixPageCriteria()
           
protected  void postExecute(COM.FutureTense.Interfaces.ICS ics)
          Template method that is called after ics.runTag and before handleError

subclasses can override

protected  void preExecute(COM.FutureTense.Interfaces.ICS ics)
          Checks the current settings and based on the current and target template state set the style to a best guess.
 CallTemplate.Style proposeStyle(COM.FutureTense.Interfaces.ICS ics)
           
 void setAsset(com.fatwire.assetapi.data.AssetId id)
           
 void setC(String s)
           
 void setCid(String s)
           
 void setContext(String s)
           
 void setFixPageCriteria(boolean fixPageCriteria)
           
 void setPackedargs(String s)
           
 void setSite(String s)
           
 void setSlotname(String s)
           
 void setStyle(CallTemplate.Style s)
           
 void setTid(String s)
           
 void setTname(String s)
           
 void setTtype(CallTemplate.Type s)
           
 void setVariant(String s)
           
 
Methods inherited from class com.fatwire.gst.foundation.facade.runtag.render.TagRunnerWithRenderArguments
setArgument, setArgument, setArgument, setArgument, setArgument
 
Methods inherited from class com.fatwire.gst.foundation.facade.runtag.AbstractTagRunner
bind, execute
 
Methods inherited from class com.fatwire.gst.foundation.facade.FTValListFacade
getList, set, set, set, set, set, set
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

CALLTEMPLATE_EXCLUDE_VARS

protected static final List<String> CALLTEMPLATE_EXCLUDE_VARS
Constructor Detail

CallTemplate

public CallTemplate()

CallTemplate

public CallTemplate(String slotname,
                    String tname,
                    CallTemplate.Type type)
Sets up CallTemplate with default Style.element

Parameters:
slotname -
tname -
type -
Method Detail

preExecute

protected void preExecute(COM.FutureTense.Interfaces.ICS ics)
Checks the current settings and based on the current and target template state set the style to a best guess. This is only done if the developer didnot explicitly set the style.

Overrides:
preExecute in class AbstractTagRunner

postExecute

protected void postExecute(COM.FutureTense.Interfaces.ICS ics)
Description copied from class: AbstractTagRunner
Template method that is called after ics.runTag and before handleError

subclasses can override

Overrides:
postExecute in class AbstractTagRunner

setSite

public void setSite(String s)

setSlotname

public void setSlotname(String s)

setTid

public void setTid(String s)

setTtype

public void setTtype(CallTemplate.Type s)

setC

public void setC(String s)

setCid

public void setCid(String s)

setTname

public void setTname(String s)

setContext

public void setContext(String s)

setStyle

public void setStyle(CallTemplate.Style s)

setVariant

public void setVariant(String s)

setPackedargs

public void setPackedargs(String s)

setAsset

public void setAsset(com.fatwire.assetapi.data.AssetId id)

proposeStyle

public CallTemplate.Style proposeStyle(COM.FutureTense.Interfaces.ICS ics)

handleError

protected void handleError(COM.FutureTense.Interfaces.ICS ics)
Description copied from class: AbstractTagRunner
default error handling method. This implemetation throws an TagRunnerRuntimeException.

subclasses can override

Overrides:
handleError in class AbstractTagRunner
See Also:
TagRunnerRuntimeException

isFixPageCriteria

public boolean isFixPageCriteria()
Returns:
the fixPageCriteria

setFixPageCriteria

public void setFixPageCriteria(boolean fixPageCriteria)
Parameters:
fixPageCriteria - the fixPageCriteria to set


Copyright © 2010-2013 Oracle Corporation. All Rights Reserved.