com.fatwire.gst.foundation.facade.runtag.asset
Class AssetList

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.asset.AssetList
All Implemented Interfaces:
TagRunner

public class AssetList
extends AbstractTagRunner

Exposes ASSET.LIST <asset:list type="assetType" list="nameOfList" [order="order"] [pubid="siteId"] [excludevoided="trueOrFalse"] [field[n]="fieldName"] [value[n]="fieldValue"]>

Since:
Sep 28, 2008
Author:
Tony Field

Field Summary
 
Fields inherited from class com.fatwire.gst.foundation.facade.FTValListFacade
list
 
Constructor Summary
AssetList()
           
 
Method Summary
static boolean assetExists(COM.FutureTense.Interfaces.ICS ics, String c, String cid)
          Return true if the asset exists in the database, and false if it does not.
static boolean assetExistsByName(COM.FutureTense.Interfaces.ICS ics, String c, String name)
           
static String getRequiredSingleField(COM.FutureTense.Interfaces.ICS ics, String c, String cid, String field)
          Get a single field from a specified asset.
protected  void handleError(COM.FutureTense.Interfaces.ICS ics)
          default error handling method.
static COM.FutureTense.Interfaces.IList listSingleAsset(COM.FutureTense.Interfaces.ICS ics, String c, String cid)
           
static com.fatwire.assetapi.data.AssetId lookupAssetId(COM.FutureTense.Interfaces.ICS ics, String c, String name)
          Look up asset id by name
 void setExcludeVoided(boolean b)
           
 void setField(String name, String value)
           
 void setList(String list)
           
 void setOrder(String order)
           
 void setPubid(String pubid)
           
 void setType(String type)
           
 
Methods inherited from class com.fatwire.gst.foundation.facade.runtag.AbstractTagRunner
bind, execute, postExecute, preExecute
 
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

AssetList

public AssetList()
Method Detail

setType

public void setType(String type)

setList

public void setList(String list)

setOrder

public void setOrder(String order)

setPubid

public void setPubid(String pubid)

setExcludeVoided

public void setExcludeVoided(boolean b)

setField

public void setField(String name,
                     String value)

assetExists

public static boolean assetExists(COM.FutureTense.Interfaces.ICS ics,
                                  String c,
                                  String cid)
Return true if the asset exists in the database, and false if it does not.

Parameters:
ics - context
c - asset type
cid - asset id
Returns:
true if the asset exists, false if it does not

assetExistsByName

public static boolean assetExistsByName(COM.FutureTense.Interfaces.ICS ics,
                                        String c,
                                        String name)

lookupAssetId

public static com.fatwire.assetapi.data.AssetId lookupAssetId(COM.FutureTense.Interfaces.ICS ics,
                                                              String c,
                                                              String name)
Look up asset id by name

Parameters:
ics - context
c - type
name - name field value
Returns:
asset id or null if not found.

getRequiredSingleField

public static String getRequiredSingleField(COM.FutureTense.Interfaces.ICS ics,
                                            String c,
                                            String cid,
                                            String field)
Get a single field from a specified asset. Only one result must be returned from this search or an exception will be thrown. Pubid is optional.

Parameters:
ics -
c -
cid -
field -
Returns:
single field value

listSingleAsset

public static COM.FutureTense.Interfaces.IList listSingleAsset(COM.FutureTense.Interfaces.ICS ics,
                                                               String c,
                                                               String cid)

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


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