com.fatwire.gst.foundation.facade.runtag.siteplan
Class NodePath

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.siteplan.NodePath
All Implemented Interfaces:
TagRunner

public class NodePath
extends AbstractTagRunner

Since:
Sep 28, 2008
Author:
Tony Field

Field Summary
 
Fields inherited from class com.fatwire.gst.foundation.facade.FTValListFacade
list
 
Constructor Summary
NodePath()
           
 
Method Summary
static COM.FutureTense.Interfaces.IList getNodePathForPage(COM.FutureTense.Interfaces.ICS ics, com.fatwire.assetapi.data.AssetId page)
          Compute and return the nodepath for the specified input asset.
static COM.FutureTense.Interfaces.IList getNodePathForPage(COM.FutureTense.Interfaces.ICS ics, long p)
          Compute and return the nodepath for the specified input asset.
static COM.FutureTense.Interfaces.IList getNodePathForPage(COM.FutureTense.Interfaces.ICS ics, String p)
          Compute and return the nodepath for the specified input asset.
static com.fatwire.assetapi.data.AssetId getParentPage(COM.FutureTense.Interfaces.ICS ics, long p)
          Get the parent page in the site plan tree of the specified page.
 void setList(String listName)
           
 void setName(String name)
           
 
Methods inherited from class com.fatwire.gst.foundation.facade.runtag.AbstractTagRunner
bind, execute, handleError, 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

NodePath

public NodePath()
Method Detail

setName

public void setName(String name)

setList

public void setList(String listName)

getNodePathForPage

public static COM.FutureTense.Interfaces.IList getNodePathForPage(COM.FutureTense.Interfaces.ICS ics,
                                                                  String p)
Compute and return the nodepath for the specified input asset. The returned list is in the same order and format as that returned by the siteplan.nodepath tag.

Parameters:
ics - context
p - page asset ID
Returns:
nodepath IList. Includes publication at root.

getNodePathForPage

public static COM.FutureTense.Interfaces.IList getNodePathForPage(COM.FutureTense.Interfaces.ICS ics,
                                                                  com.fatwire.assetapi.data.AssetId page)
Compute and return the nodepath for the specified input asset. The returned list is in the same order and format as that returned by the siteplan.nodepath tag.

Parameters:
ics - context
page - page asset ID
Returns:
nodepath IList. Includes publication at root.

getParentPage

public static com.fatwire.assetapi.data.AssetId getParentPage(COM.FutureTense.Interfaces.ICS ics,
                                                              long p)
Get the parent page in the site plan tree of the specified page. If the page cannot be located in the site plan tree, an exception is thrown. If the page has no parents in the site plan tree, an exception is thrown.

Parameters:
ics - ICS context
p - ID of page asset to inspect
Returns:
ID of parent page, never null.

getNodePathForPage

public static COM.FutureTense.Interfaces.IList getNodePathForPage(COM.FutureTense.Interfaces.ICS ics,
                                                                  long p)
Compute and return the nodepath for the specified input asset. The returned list is in the same order and format as that returned by the siteplan.nodepath tag.

Parameters:
ics - context
p - page asset ID
Returns:
nodepath IList. Includes publication at root.


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