com.fatwire.gst.foundation.facade.runtag

Class AbstractTagRunner

java.lang.Object

com.fatwire.gst.foundation.facade.FTValListFacade

com.fatwire.gst.foundation.facade.runtag.AbstractTagRunner

All Implemented Interfaces:

TagRunner

Direct Known Subclasses:

AbstractAssetLoad, AddRow, AssetCreate, AssetExport, AssetInspect, AssetList, AssetLoadAll, AssetSave, AssetScatter, AssetSet, AssetSetSubType, Children, Create, Get, GetAlias, GetAttributeValues, GetBlobUrl, GetMultipleValues, GetRecommendations, GetScalar, GetSiteNode, GetSubtype, ListPages, Load, LogDep, Login, Logout, Logout, Lookup, Lookup, NodePath, Page, PublicationCreate, PublicationGather, PublicationGet, PublicationLoad, PublicationSave, Send, SendMail, SetAlias, SetAsset, SetScalar, SitePlanGet, SitePlanLoad, Stream, TagRunnerWithArguments, ToList, Unknowndeps

public abstract class AbstractTagRunner
extends FTValListFacade
implements TagRunner

Author:

Dolf Dijkstra

Field Summary

Fields inherited from class com.fatwire.gst.foundation.facade.FTValListFacade

list

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTagRunner(String tagName)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	bind(COM.FutureTense.Interfaces.ICS ics) Template method to bind variables on ics (or any object space) to the current object.
String	execute(COM.FutureTense.Interfaces.ICS ics) Executes the tag via ics.runtag order is bind(ics); preExecute(); ics.runTag(); postExceute(); handleError() if runTag or postExecute set errno to anything else then zero.
protected void	handleError(COM.FutureTense.Interfaces.ICS ics) default error handling method.
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) Template method that is called before ics.runTag subclasses can override

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

Constructor Detail

AbstractTagRunner

protected AbstractTagRunner(String tagName)

Parameters:

tagName - the name of the tag to be invoked.

Method Detail

bind

protected void bind(COM.FutureTense.Interfaces.ICS ics)

Template method to bind variables on ics (or any object space) to the current object.

Implementation in this class does nothing, subclasses can override.

Parameters:

ics -

execute

public String execute(COM.FutureTense.Interfaces.ICS ics)

Executes the tag via ics.runtag

order is

• bind(ics);
• preExecute();
• ics.runTag();
• postExceute();
• handleError() if runTag or postExecute set errno to anything else then zero.

Specified by:

execute in interface TagRunner

Returns:

the returned string from ICS.runTag(String, COM.FutureTense.Interfaces.FTValList)

See Also:

TagRunner.execute(ICS)

preExecute

protected void preExecute(COM.FutureTense.Interfaces.ICS ics)

Template method that is called before ics.runTag

subclasses can override

Parameters:

ics -

postExecute

protected void postExecute(COM.FutureTense.Interfaces.ICS ics)

Template method that is called after ics.runTag and before handleError

subclasses can override

Parameters:

ics -

handleError

protected void handleError(COM.FutureTense.Interfaces.ICS ics)

default error handling method. This implemetation throws an TagRunnerRuntimeException.

subclasses can override

Parameters:

ics -

See Also:

TagRunnerRuntimeException