|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.stellent.wcm.client.script.ScriptMethods
public class ScriptMethods
Methods made available in the wcm-taglib as functions
Constructor Summary | |
---|---|
ScriptMethods() |
Method Summary | |
---|---|
static java.util.List<SectionNode> |
filterSections(SiteContext siteContext, java.util.List sections) Filter a section list to remove inactive sections and contributor-only sections if not in contribution mode. |
static java.lang.String |
formatMessage(LocaleMessage localeMessage, java.util.Locale locale) Format a message with the given locale |
static java.util.List<Mapping> |
getLocalPageTemplates(ClientApplication clientApplication) Load a list of local page templates |
static java.lang.String |
getStackTrace(java.lang.Throwable error) Retrieve the error stack trace for an exception |
static boolean |
isNodeInNavigationPath(SiteContext siteContext, java.lang.String nodeID, boolean includeHome) Look to see if the current node is in the navigation path |
static java.util.List |
listSectionsForRows(SiteContext siteContext, int startLevel, int stopLevel, boolean includeHome) Create a list of sections matching the given parameters. |
static ContentStream |
loadContent(ClientApplication clientApplication, java.lang.String dDocName) Load some content from the configured content adapter |
static ContentStream |
loadDataFile(ClientApplication clientApplication, java.lang.String dDocName, ContentAdapter.DataFileParams params) Load a data file or dynamic conversion from the Content Server. |
static ContentStream |
loadRendition(ClientApplication clientApplication, java.lang.String dDocName, java.lang.String rendition) Load a specific content rendition from the Content Server. |
static SectionNode |
lookupSection(SiteContext siteContext, java.lang.String id) Lookup a section by path or ID |
static void |
setConsumptionMode(SiteContext siteContext) Set the siteContext mode to Consumption |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ScriptMethods()
Method Detail |
---|
public static java.util.List<SectionNode> filterSections(SiteContext siteContext, java.util.List sections)
siteContext
- the site contextsections
- a list of SectionNode
objectspublic static java.util.List listSectionsForRows(SiteContext siteContext, int startLevel, int stopLevel, boolean includeHome)
siteContext
- the site contextstartLevel
- the level to start (inclusive)stopLevel
- the level to stop (inclusive)includeHome
- true to include the home sectionpublic static boolean isNodeInNavigationPath(SiteContext siteContext, java.lang.String nodeID, boolean includeHome)
siteContext
- the site contextnodeID
- the node IDincludeHome
- true to include the home section in this check, false to excludepublic static SectionNode lookupSection(SiteContext siteContext, java.lang.String id)
siteContext
- the site contextid
- the section path or IDpublic static java.lang.String formatMessage(LocaleMessage localeMessage, java.util.Locale locale)
localeMessage
- the local messagelocale
- the locale to output the messagepublic static java.lang.String getStackTrace(java.lang.Throwable error)
error
- the errorpublic static ContentStream loadContent(ClientApplication clientApplication, java.lang.String dDocName) throws java.io.IOException, oracle.stellent.ridc.IdcClientException
clientApplication
- the client applicationdDocName
- the content IDoracle.stellent.ridc.IdcClientException
java.io.IOException
ContentAdapter.getContentUri(oracle.stellent.wcm.server.content.spi.ContentID, oracle.stellent.ridc.model.DataBinder)
public static ContentStream loadDataFile(ClientApplication clientApplication, java.lang.String dDocName, ContentAdapter.DataFileParams params) throws java.io.IOException, oracle.stellent.ridc.IdcClientException
clientApplication
- the client applicationdDocName
- the content IDparams
- the data fail parametersoracle.stellent.ridc.IdcClientException
java.io.IOException
ContentAdapter.getDataFileUri(oracle.stellent.wcm.server.content.spi.ContentID, oracle.stellent.ridc.model.DataBinder, oracle.stellent.wcm.server.content.spi.ContentAdapter.DataFileParams)
public static ContentStream loadRendition(ClientApplication clientApplication, java.lang.String dDocName, java.lang.String rendition) throws java.io.IOException, oracle.stellent.ridc.IdcClientException
clientApplication
- the client applicationdDocName
- the content IDrendition
- the renditionoracle.stellent.ridc.IdcClientException
java.io.IOException
ContentAdapter.getRenditionUri(oracle.stellent.wcm.server.content.spi.ContentID, oracle.stellent.ridc.model.DataBinder, oracle.stellent.wcm.server.content.spi.ContentAdapter.RenditionParams)
public static java.util.List<Mapping> getLocalPageTemplates(ClientApplication clientApplication) throws ApplicationException
clientApplication
- the client applicationApplicationException
public static void setConsumptionMode(SiteContext siteContext)
siteContext
- the site context
|
Oracle® Fusion Middleware Site Studio for External Applications Java API Reference 11g Release 1 (11.1.1) E17273-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |