ICS (Oracle WebCenter Sites Java API Reference)

```
public interface ICS
```
Primary interface for accessing Content Server functionality. Nearly all platform-level functions are available through this interface.

Version:

$Revision: 122 $

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`blobSrvGuid_id` GUID string for the BlobServer
`static String`	`cacheSrvGuid_id` GUID string for the CacheServer
`static String`	`catManGuid_id` GUID string for the CatalogManager
`static String`	`conSrvGuid_id` GUID string for the ContentServer
`static int`	`ContentCatalog` Catalog type for use with GetCatalogType
`static String`	`evalSrvGuid_id` GUID string for the EvalServer
`static int`	`ForeignCatalog` Catalog type for use with GetCatalogType
`static int`	`HTTPVERSION10`
`static int`	`HTTPVERSION11`
`static int`	`NoSuchCatalog` Catalog type for use with GetCatalogType
`static int`	`ObjectCatalog` Catalog type for use with GetCatalogType
`static String`	`SQLExpAND` AND type string for use with SQLExp
`static String`	`SQLExpIN` IN type string for use with SQLExp
`static String`	`SQLExpOR` OR type string for use with SQLExp
`static int`	`SystemCatalog` Catalog type for use with GetCatalogType
`static int`	`TempCatalog` Catalog type for use with GetCatalogType
`static int`	`TempTreeCatalog` Catalog type for use with GetCatalogType
`static int`	`TRACKING_LOCKEDBYOTHER` Tracking status code for getTrackingStatus()
`static int`	`TRACKING_LOCKEDBYUSER` Tracking status code for getTrackingStatus()
`static int`	`TRACKING_NOACCESS` Tracking status code for getTrackingStatus()
`static int`	`TRACKING_NOTLOCKED` Tracking status code for getTrackingStatus()
`static int`	`TRACKING_NOTTRACKED` Tracking status code for getTrackingStatus()
`static int`	`TRACKING_UNKNOWN` Tracking status code for getTrackingStatus()
`static int`	`TreeCatalog` Catalog type for use with GetCatalogType
`static String`	`treeManGuid_id` GUID string for the TreeManager

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`AppEvent(String name, String guid, String times, FTValList params)` Create an event which triggers a registered function (via GUID or class)
`boolean`	`BlobServer(FTValList args, COM.FutureTense.Interfaces.IMIMENotifier im, OutputStream os)` Invoke the BlobServer to retrieve a blob into an output stream internal
`boolean`	`BlobServer(FTValList args, OutputStream os)` Invoke the BlobServer to retrieve a blob into an output stream
`boolean`	`CallElement(String elementname, FTValList lin)` Executes a registered element.
`IList`	`CallSQL(String qryname, String listname, int limit, boolean bCache, boolean bLoad, StringBuffer errstr)` Executes a stored SQL statement.
`IList`	`CallSQL(String qryname, String listname, int limit, boolean bLoadCache, StringBuffer errstr)` Executes a stored SQL statement.
`IList`	`CatalogDef(String from, String listname, StringBuffer errstr)` Queries a catalog for its column definition and stores the results in a list.
`IList`	`CatalogIndexDef(String from, String listname, StringBuffer errstr)` Queries a catalog for its index definition and stores the results in a list.
`boolean`	`CatalogManager(FTValList lin)` Executes the Catalog Manager logic class This method is analogous to the XML <CATALOGMANAGER> command.
`boolean`	`CatalogManager(FTValList lin, Object oBatchContext)` Executes the Catalog Manager logic class This method is analogous to the XML <CATALOGMANAGER> command.
`void`	`ClearErrno()` Clears the current error code, setting it to 0.
`void`	`close()` Method to close and release any resources associated with this object
`boolean`	`CommitBatchedCommands(Object oBatchContext)` Commit CatalogManager and TreeManager commands queued to the batch context
`boolean`	`CopyList(String list, String newname)` Copies a list object.
`boolean`	`dbDebug()` Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of `ftMessage.DB_DEBUG`
`void`	`decode(String sAttributes, Map map)` Method to split the attribute portion of a URL string into a set of attributes.
`boolean`	`DeleteSynchronizedHash(String name)` Destroy a synchronized hash
`COM.FutureTense.Interfaces.IJSPObject`	`deployJSPData(String sData, String sZone, StringBuffer sbError)` Deploy JSP data contained in a buffer.
`COM.FutureTense.Interfaces.IJSPObject`	`deployJSPFile(String sPath, String sZone, StringBuffer sbError)` Deploy a JSP file.
`boolean`	`DestroyEvent(String name)` Destroy a registered event by name
`void`	`DisableCache()` Disables any caching of the current execution thread.
`boolean`	`DisableEvent(String name)` Disabled a registered event by name
`void`	`DisableFragmentCache()` Disable caching on this fragment and all of its parents, but not any of its children.
`String`	`diskFileName()` Deprecated. Method is disabled since cached pages are stored in the database now.
`String`	`diskFileName(String pname, FTValList arguments)` Deprecated. Method is disabled since cached pages are stored in the database now.
`String`	`diskFileName(String pname, String arguments)` Deprecated. Method is disabled since cached pages are stored in the database now.
`boolean`	`EmailEvent(String name, String tolist, String times, String filespec)` Create an event which triggers an email
`boolean`	`EmailEvent(String name, String tolist, String times, String filespec, String contenttype, String charset, FTValList attachments)` Create an event which triggers an email
`boolean`	`EnableEvent(String name)` Enabled a registered event by name
`String`	`encode(String base, Map map, boolean bSession)` Method to build an encoded URL string from a set of attributes
`boolean`	`eventDebug()` Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of `ftMessage.EVENT_DEBUG`
`boolean`	`FlushCatalog(String catname)` Flushes any cached information on a named catalog.
`void`	`FlushStream()` Flush the output stream of pending data (not stuff in cache for page)
`String`	`genID(boolean bClusterSafe)` Generate a unique number.
`Object`	`getAttribute(String sName)` Method to get an attribute value from the request
`Enumeration`	`getAttributeNames()` Method to get an enumeration of all the request attribute names
`byte[]`	`GetBin(String name)` Returns the value of a binary variable, such as a posted value.
`int`	`GetCatalogType(String catalog)` Gets the type of a catalog.
`FTVAL`	`GetCgi(String name)` Gets variable value even if the value is binary.
`ftErrors`	`getComplexError()` Get error details in the form of COM.FutureTense.Util.ftErrors.
`String`	`getCookie(String sName)` Get the value of a cookie from the header
`int`	`GetCounter(String counter)` Returns the value of a counter.
`String`	`getElementArgumentValue(String element, String argument)` Retrieves the argument value of an element.
`int`	`GetErrno()` Returns the current error code.
`COM.FutureTense.Interfaces.IProperties`	`getIProperties()` Return an IProperties object that provides access to the properties that are currently loaded into the CS context.
`IServlet`	`getIServlet()` Deprecated. The IServlet interface is not portable across various containers, and as such its use should be limited.
`IList`	`GetList(String listname)` The GetList method retrieves the IList object for the given list name.
`IList`	`GetList(String listname, boolean reset)` The GetList method retrieves the IList object for the given list name.
`String`	`getLocaleString(String sName, String sLocale)` Method to get a locale specific string
`String`	`getNamespace()` The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the generated page.
`Object`	`GetObj(String name)` Retrieve the last object saved earlier in this same thread using #SetObj(String, Object) or #PushObj(String, Object).
`COM.FutureTense.ContentServer.PageData`	`getPageData(String pagename)` Get the PageData object for the specified pagename
`COM.FutureTense.Interfaces.PastramiEngine`	`getPastramiEngine()` Method to return a PastramiEngine object based on the value of the propety cs.PastramiEngine or the override class name passed in
`String`	`GetProperty(String name)` Gets a property from the ContentServer property file.
`String`	`GetProperty(String name, String files, boolean append)` Gets a property from the a property file set.
`COM.FutureTense.Cache.Satellite`	`getSatellite(String id)` Method to get read-only information about a Satellite server.
`COM.FutureTense.Interfaces.ISearchEngine`	`GetSearchEngine(String sEngine, String sCharset, StringBuffer errstr)` Get an instance of the specified search engine.
`String`	`GetSearchEngineList()` Get a string list of the available search engines.
`String`	`getSQL(String qryname)` Method to get the SQL String given the query name
`String`	`GetSSVar(String name)` Returns the value of a session variable.
`Enumeration`	`GetSSVars()` Returns an enumeration of all session variables.
`ISyncHash`	`GetSynchronizedHash(String name, boolean bCreate, int timeout, int size, boolean bAbsolute, boolean bClusterSync)` Locate/create a named synchronized hash
`ISyncHash`	`GetSynchronizedHash(String name, boolean bCreate, int timeout, int size, boolean bAbsolute, boolean bClusterSync, Collection linked)` Locate/create a named synchronized hash
`int`	`getTrackingStatus(String sTable, String sId)` Method to get the tracking status for a row in a table
`String`	`getURL(Definition definition, String assembler)` Method to generate a URI appropriate for the request
`String`	`getURL(COM.FutureTense.Interfaces.IURLDefinition oIURLDefinition)` Deprecated. Use `ICS.getURL(Definition,String)` instead. This method will be removed after Content Server 6.1
`Principal`	`getUserPrincipal()` Returns a java.security.Principal object containing the name of the current authenticated user.
`String`	`GetVar(String name)` Returns the value of a variable.
`Enumeration`	`GetVars()` Returns an enumeration of all variables.
`byte[]`	`grabCacheStatus()` get the cache status
`FTValList`	`grabHeaders()` Get headers set since last call
`boolean`	`IndexAdd(String sIndex, String sEntryName, String sEntryDetail, String sWordList, String sWordListDelimiters, String sFileList, String sDate, FTValList vlTextArguments, FTValList vlFileArguments, FTValList vlDateArguments, String sEngine, String sCharset, StringBuffer sbError)` Adds an item to the search index.
`boolean`	`IndexCreate(String sIndex, FTValList vlFieldArguments, String sEngine, String sCharset, StringBuffer errstr)` Creates a search index.
`boolean`	`IndexDestroy(String sIndex, String sEngine, String sCharset, StringBuffer sbError)` Deletes a search index.
`boolean`	`IndexExists(String sIndex, String sEngine, String sCharset, StringBuffer sbError)` Checks for the existence a search index.
`boolean`	`IndexRemove(String sIndex, String sEntryName, String sEngine, String sCharset, StringBuffer sbError)` Removes a search index entry.
`boolean`	`IndexReplace(String sIndex, String sEntryName, String sEntryDetail, String sWordList, String sWordListDelimiters, String sFileList, String sDate, FTValList vlTextArguments, FTValList vlFileArguments, FTValList vlDateArguments, String sEngine, String sCharset, StringBuffer sbError)` Replaces an item in the search index.
`boolean`	`InsertPage(String pagename, FTValList lin)` Invokes a pagelet inline with the current evaluation.
`boolean`	`ioErrorThrown()` Check to see if the http request has registered an io error ie broken pipe
`boolean`	`isCacheable(String pagename)` Determine if a page is set to cache at this time.
`boolean`	`IsElement(String element)` Checks for the existance of an element.
`boolean`	`IsSystemSecure()` Return if the current thread is running with CS security on or off - depends on property file setting and if off, no access restrictions will be in place at the core catalog level
`boolean`	`IsTracked(String catalog)` Checks if a catalog is revision tracked.
`boolean`	`IsTrackedNewFormat(String catalog)` Checks if a catalog is revision tracked with the new 8.0 format.
`String`	`literal(String sTable, String sColumn, String sValue)` Generates a literal value specific to a column in a table.
`boolean`	`LoadProperty(String name)` Loads a new property set into the system.
`void`	`LogMsg(String msg)` Deprecated. Use Apache's commons-logging module instead. Out of the box Logger names are identified in `ftMessage`.
`int`	`Mirror(IList list, String sTarget, String sUsername, String sPassword, String sCGIPrefix, String sTargetIniFile, int nPort, boolean bUseProxy, String proxyserver, String proxyport, String proxyuser, String proxypassword, boolean bUseHTTPS, int nHTTPVersion, String tableToMirror, StringBuffer sbOutput)` Mirrors a result set.
`int`	`Mirror(Vector vILists, String sTarget, String sUsername, String sPassword, String sCGIPrefix, String sTargetIniFile, int nPort, boolean bUseProxy, boolean bUseHTTPS, int nHTTPVersion, StringBuffer sbOutput)` Mirrors a result set.
`int`	`Mirror(Vector vILists, String sTarget, String sUsername, String sPassword, String sCGIPrefix, String sTargetIniFile, int nPort, boolean bUseProxy, String proxyserver, String proxyport, String proxyuser, String proxypassword, boolean bUseHTTPS, int nHTTPVersion, StringBuffer sbOutput)` Mirrors a result set.
`int`	`Mirror(Vector vILists, Vector vTreeList, String sTarget, String sUsername, String sPassword, String sCGIPrefix, String sTargetIniFile, int nPort, boolean bUseProxy, boolean bUseHTTPS, int nHTTPVersion, StringBuffer sbOutput)` Mirrors a result set.
`int`	`Mirror(Vector vILists, Vector vTreeList, String sTarget, String sUsername, String sPassword, String sCGIPrefix, String sTargetIniFile, int nPort, boolean bUseProxy, String proxyserver, String proxyport, String proxyuser, String proxypassword, boolean bUseHTTPS, int nHTTPVersion, StringBuffer sbOutput)` Mirrors a result set.
`Seed`	`NewSeedFromTagname(String tagname)` Deprecated. use ICS.runTag(String, FTValList) instead
`String[]`	`pageCriteriaKeys(String pagename)` Get a String array of page criteria allowable keynames
`String`	`pageURL()` Return the cache key in 'url' form of the current execution instance (page/pagelet).
`String`	`pageURL(String pname, FTValList arguments)` Return the cache key in 'url' form of the execution instance (page/pagelet) defined by the input parameters.
`boolean`	`pastramiDebug()` Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of `ftMessage.GENERIC_DEBUG`
`boolean`	`pgCacheDebug()` Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of `ftMessage.PAGE_CACHE_DEBUG`
`Object`	`PopObj(String name)` Pop the last object saved earlier in this same thread by a given name.
`void`	`PopVars()` Pops the variable stack, returning the variables to their previously stacked state.
`boolean`	`PushObj(String name, Object value)` Save an object by name, and retain any object previously saved by that same name.
`void`	`PushVars()` Saves a copy of all the current variables to a stack.
`IList`	`QueryEvents(String sNamePattern, String sType, Boolean bEnabled, String sList)` Attempt to query for a list of matching events
`IList`	`ReadEvent(String sEvent, String sList)` Attempt to read an event record
`String`	`ReadPage(String pagename, FTValList lin)` Invokes a pagelet through Content Server.
`boolean`	`RegisterList(String listname, IList ilist)` Register an IList object with CS for use in XML tagging; this assumes that the IList was created in a manner that did not implicitly register the name, as would be the case with the listname parameter to SQL(), SelectTo(), etc.
`void`	`removeAttribute(String sName)` Method to remove an attribute from the request
`void`	`RemoveCounter(String name)` Remove counter
`void`	`RemoveSSVar(String name)` Removes a session variable.
`void`	`RemoveVar(String name)` Removes a variable.
`boolean`	`RenameList(String list, String newname)` Renames a list object.
`String`	`ResolveVariables(String st)` Resolves any variable, query column value, counter or property in this string.
`String`	`ResolveVariables(String st, boolean bNew)` Resolves any variable, query column value, counter or property in this string.
`boolean`	`RestoreProperty(boolean bClose)` Restores the previous property set into the system.
`boolean`	`RollbackBatchedCommands(Object oBatchContext)` Abort CatalogManager and TreeManager commands queued to the batch context
`boolean`	`rsCacheDebug()` Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of `ftMessage.RESULT_SET_CACHE_DEBUG`
`int`	`RTCommit(String sTable, String sAsset, String sAnnotation, boolean bKeepLocked)` Creates a new revision of a record from a tracked table.
`int`	`RTDeleteRevision(String sTable, String sAsset, int nVersion)` Deletes a revision of a row from a tracked table.
`IList`	`RTHistory(String sTable, String sAsset, String sVersion, String sLocker, String sCreator, String sAnnotation, String sListName)` Returns revision history for rows in a revision tracked table.
`IList`	`RTInfo(String sTable, String sListName)` Returns information on tracked tables from the RTInfo table
`int`	`RTLock(String sTable, String sAsset)` Locks a record by the current user in a tracked table.
`int`	`RTRelease(String sTable, String sAsset)` Release a lock on a row from a tracked table.
`IList`	`RTRetrieveRevision(String strTableName, String strAsset, int nVersion, String listName)` This method returns a specific version for a tracked table.
`IList`	`RTRetrieveRevision(String strTableName, String strAsset, String strVersion, String listName)` This method returns a specific version for a tracked table.
`int`	`RTRollback(String sTable, String sAsset, int nVersion)` Reverts a row in a tracked table to a previous revision.
`int`	`RTRollback(String sTable, String sAsset, String strVersion)` Reverts a row in a tracked table to a previous revision.
`int`	`RTSetVersions(String sTable, int nVersions)` Sets the number of revisions stored for each row in a tracked table.
`int`	`RTTrackTable(String sTable, String sStorage, int nVersions)` Enables revision tracking operations on a table.
`int`	`RTUnlockRecord(String sTable, String sAsset)` Unlocks a locked row.
`int`	`RTUntrackTable(String sTable)` Stops tracking a table.
`String`	`runTag(String sTag, FTValList vIn)` Method to execute a simple XML tag by name.
`IList`	`Search(String sIndex, String sWhat, String sRelevence, String sQueryParser, int nMaxResults, FTValList vlAdditionalIndexes, String sList, String sEngine, String sCharset, StringBuffer sbError)` Searches an index.
`boolean`	`SearchDateToNative(String sDate, StringBuffer sbOut, String sEngine, String sCharset, StringBuffer sbError)` Converts a javaSQL date string to native search engine format.
`IList`	`SelectTo(String from, String what, String where, String orderby, int limit, String listname, boolean bCache, StringBuffer errstr)` Performs a simple query by specifing a list of column names to return, and a list of column names to use as filtering.
`boolean`	`SendMail(String to, String subject, String body)` Sends an email to the specified address.
`boolean`	`SendMail(String to, String subject, String body, String replyto, String contenttype)` Sends an email to the specified address.
`boolean`	`SendMail(String to, String subject, String body, String replyto, String contenttype, String charset, FTValList attachments)` Sends an email to the specified address.
`boolean`	`sessionDebug()` Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of `ftMessage.SESSION_DEBUG`
`boolean`	`SessionExists(String id)` Deprecated. this always returns false
`String`	`SessionID()` Find out the session id being used by this user session.
`void`	`setAttribute(String sName, Object oValue)` Method to set an attribute for the request
`void`	`setComplexError(ftErrors error)` Set a complex error using COM.FutureTense.Util.ftErrors
`boolean`	`SetCookie(String name, String value, int timeout, String url, String domain, boolean bSecure)` Sets or removes a cookie.
`void`	`SetCounter(String counter, int value)` Set a counter
`void`	`SetErrno(int i)` Set the current error code as an integer.
`boolean`	`SetObj(String name, Object value)` Save an object by name.
`void`	`SetSSVar(String name, int value)` Sets a session variable to the specified value.
`void`	`SetSSVar(String name, String value)` Sets a session variable to the specified value.
`void`	`SetVar(String name, FTVAL value)` Sets a variable to the specified value.
`void`	`SetVar(String name, int value)` Sets a variable to the specified value.
`void`	`SetVar(String name, String value)` Sets a variable to the specified value.
`IList`	`SQL(PreparedStmt stmt, com.fatwire.cs.core.db.StatementParam data, boolean bCache)` Executes a given PreparedStmt with supplied data; returns data in the form of an IList.
`IList`	`SQL(String from, String sqlstmt, String listname, int limit, boolean bCache, boolean bLoad, StringBuffer errstr)` Executes an SQL statement.
`IList`	`SQL(String from, String sqlstmt, String listname, int limit, boolean bLoadCache, StringBuffer errstr)` Executes an SQL statement.
`String`	`SQLExp(String table, String type, String verb, String arg, String column)` Generates an expression for an SQL WHERE clause This method is analgous to the XML <SQLExp> command.
`String`	`SQLExp(String table, String type, String verb, String arg, String column, String expression)` Generates an expression for an SQL WHERE clause
`Object`	`StartBatchContext()` Fetch Batch context object to queue CatalogManager and TreeManager commands
`void`	`StreamBinary(byte[] b, int offset, int length)` Deprecated.
`void`	`StreamEvalBytes(String msg)` Writes a string to the current element evaluation stream; it will be appended to the current element output buffer.
`void`	`StreamHeader(String header, String text)` Immediately stream header data.
`void`	`StreamText(String text)` Immediately streams text out to the ICS context (RIGHT NOW).
`boolean`	`syncDebug()` Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of `ftMessage.SYNC_DEBUG`
`boolean`	`systemDebug()` Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of `ftMessage.GENERIC_DEBUG`
`boolean`	`systemSession()` Are sessions enabled for the current pagelet?
`void`	`ThrowException()` Interface to xml THROWEXCEPTION functionality - this effects the entire thread ie http request
`boolean`	`timeDebug()` Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of `ftMessage.TIME_DEBUG`
`boolean`	`TreeManager(FTValList lin)` Executes the Tree Manager logic class This method is analogous to the XML <TREEMANAGER> command.
`boolean`	`TreeManager(FTValList lin, Object oBatchContext)` Executes the Tree Manager logic class This method is analogous to the XML <TREEMANAGER> command.
`boolean`	`UserIsMember(String grouplist)` Determines if the currently logged in user is a member of a supplied group.
`boolean`	`xmlDebug()` Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of `ftMessage.XML_DEBUG`

- Field Detail
  - HTTPVERSION10
```
static final int HTTPVERSION10
```
    See Also:
    
    Constant Field Values
  - HTTPVERSION11
```
static final int HTTPVERSION11
```
    See Also:
    
    Constant Field Values
  - conSrvGuid_id
```
static final String conSrvGuid_id
```
    GUID string for the ContentServer
    
    See Also:
    
    Constant Field Values
  - catManGuid_id
```
static final String catManGuid_id
```
    GUID string for the CatalogManager
    
    See Also:
    
    Constant Field Values
  - treeManGuid_id
```
static final String treeManGuid_id
```
    GUID string for the TreeManager
    
    See Also:
    
    Constant Field Values
  - blobSrvGuid_id
```
static final String blobSrvGuid_id
```
    GUID string for the BlobServer
    
    See Also:
    
    Constant Field Values
  - evalSrvGuid_id
```
static final String evalSrvGuid_id
```
    GUID string for the EvalServer
    
    See Also:
    
    Constant Field Values
  - cacheSrvGuid_id
```
static final String cacheSrvGuid_id
```
    GUID string for the CacheServer
    
    See Also:
    
    Constant Field Values
  - SQLExpAND
```
static final String SQLExpAND
```
    AND type string for use with SQLExp
    
    See Also:
    
    Constant Field Values
  - SQLExpOR
```
static final String SQLExpOR
```
    OR type string for use with SQLExp
    
    See Also:
    
    Constant Field Values
  - SQLExpIN
```
static final String SQLExpIN
```
    IN type string for use with SQLExp
    
    See Also:
    
    Constant Field Values
  - NoSuchCatalog
```
static final int NoSuchCatalog
```
    Catalog type for use with GetCatalogType
    
    See Also:
    
    Constant Field Values
  - SystemCatalog
```
static final int SystemCatalog
```
    Catalog type for use with GetCatalogType
    
    See Also:
    
    Constant Field Values
  - ContentCatalog
```
static final int ContentCatalog
```
    Catalog type for use with GetCatalogType
    
    See Also:
    
    Constant Field Values
  - ForeignCatalog
```
static final int ForeignCatalog
```
    Catalog type for use with GetCatalogType
    
    See Also:
    
    Constant Field Values
  - TreeCatalog
```
static final int TreeCatalog
```
    Catalog type for use with GetCatalogType
    
    See Also:
    
    Constant Field Values
  - ObjectCatalog
```
static final int ObjectCatalog
```
    Catalog type for use with GetCatalogType
    
    See Also:
    
    Constant Field Values
  - TempCatalog
```
static final int TempCatalog
```
    Catalog type for use with GetCatalogType
    
    See Also:
    
    Constant Field Values
  - TempTreeCatalog
```
static final int TempTreeCatalog
```
    Catalog type for use with GetCatalogType
    
    See Also:
    
    Constant Field Values
  - TRACKING_UNKNOWN
```
static final int TRACKING_UNKNOWN
```
    Tracking status code for getTrackingStatus()
    
    See Also:
    
    ICS.getTrackingStatus(java.lang.String, java.lang.String), Constant Field Values
  - TRACKING_NOTTRACKED
```
static final int TRACKING_NOTTRACKED
```
    Tracking status code for getTrackingStatus()
    
    See Also:
    
    ICS.getTrackingStatus(java.lang.String, java.lang.String), Constant Field Values
  - TRACKING_NOTLOCKED
```
static final int TRACKING_NOTLOCKED
```
    Tracking status code for getTrackingStatus()
    
    See Also:
    
    ICS.getTrackingStatus(java.lang.String, java.lang.String), Constant Field Values
  - TRACKING_LOCKEDBYOTHER
```
static final int TRACKING_LOCKEDBYOTHER
```
    Tracking status code for getTrackingStatus()
    
    See Also:
    
    ICS.getTrackingStatus(java.lang.String, java.lang.String), Constant Field Values
  - TRACKING_LOCKEDBYUSER
```
static final int TRACKING_LOCKEDBYUSER
```
    Tracking status code for getTrackingStatus()
    
    See Also:
    
    ICS.getTrackingStatus(java.lang.String, java.lang.String), Constant Field Values
  - TRACKING_NOACCESS
```
static final int TRACKING_NOACCESS
```
    Tracking status code for getTrackingStatus()
    
    See Also:
    
    ICS.getTrackingStatus(java.lang.String, java.lang.String), Constant Field Values
- Method Detail
  - PushVars
```
void PushVars()
```
    Saves a copy of all the current variables to a stack. The current variable state is unchanged.
    
    See Also:
    
    ICS.PopVars()
  - PopVars
```
void PopVars()
```
    Pops the variable stack, returning the variables to their previously stacked state. If the stack is empty, popVars() does nothing.
    
    See Also:
    
    ICS.PushVars()
  - SetVar
```
void SetVar(String name,
            String value)
```
    Sets a variable to the specified value. If the variable does not exist, SetVar() creates it.
    
    Parameters:
    
    name - The name of the variable you wish to set.
    
    value - The value to set the variable to.
    
    See Also:
    
    ICS.GetVar(String), ICS.RemoveVar(String)
  - SetObj
```
boolean SetObj(String name,
               Object value)
```
    Save an object by name. Useful for keeping objects saved during a thread. Any previous objects saved by the same name will be lost. Care should be taken when using objects within cached pagelets to avoid unexpected behaviour.
    
    Parameters:
    
    name - name of object
    
    value - object to save, setting to null removes object
    
    Returns:
    
    Returns true on success, false on failure. Use GetErrno() to view the error.
    
    See Also:
    
    ICS.GetObj(String), ICS.PopObj(String), ICS.PushObj(String,Object)
  - GetObj
```
Object GetObj(String name)
```
    Retrieve the last object saved earlier in this same thread using #SetObj(String, Object) or #PushObj(String, Object). Care should be taken when using objects within cached pagelets to avoid unexpected behaviour.
    
    Parameters:
    
    name - name of object
    
    Returns:
    
    saved object or null if no object was saved
    
    See Also:
    
    ICS.PopObj(String), ICS.PushObj(String,Object), ICS.SetObj(String,Object)
  - PopObj
```
Object PopObj(String name)
```
    Pop the last object saved earlier in this same thread by a given name. Care should be taken when using objects within cached pagelets to avoid unexpected behaviour.
    
    Parameters:
    
    name - String name of the object
    
    Returns:
    
    saved object or null if no object was saved
    
    Since:
    
    4.0
    
    See Also:
    
    ICS.GetObj(String), ICS.PushObj(String,Object), ICS.SetObj(String,Object)
  - PushObj
```
boolean PushObj(String name,
                Object value)
```
    Save an object by name, and retain any object previously saved by that same name. Useful for keeping objects saved during a thread. Care should be taken when using objects within cached pagelets to avoid unexpected behaviour.
    
    Parameters:
    
    name - String name of the object
    
    value - Object to be pushed
    
    Returns:
    
    true on success else false
    
    Since:
    
    4.0
    
    See Also:
    
    ICS.GetObj(String), ICS.PopObj(String), ICS.SetObj(String,Object)
  - GetVar
```
String GetVar(String name)
```
    Returns the value of a variable. If the variable does not exist, returns null.
    
    Parameters:
    
    name - The name of the variable.
    
    Returns:
    
    The value of the variable. Returns null if the variable does not exist.
    
    See Also:
    
    ICS.SetVar(String,String), ICS.SetVar(String,int), ICS.RemoveVar(String)
  - GetBin
```
byte[] GetBin(String name)
```
    Returns the value of a binary variable, such as a posted value. If the variable does not exist, returns null.
    
    Parameters:
    
    name - The name of the variable.
    
    Returns:
    
    The value of the variable. Returns null if the variable does not exist.
    
    See Also:
    
    FTValList.getValBLOB(java.lang.String), ICS.GetCgi(java.lang.String), ICS.GetVar(java.lang.String)
  - GetCounter
```
int GetCounter(String counter)
        throws Exception
```
    Returns the value of a counter.
    
    Parameters:
    
    counter - name
    
    Returns:
    
    int
    
    Throws:
    
    Exception - if failure
  - SetCounter
```
void SetCounter(String counter,
                int value)
         throws Exception
```
    Set a counter
    
    Parameters:
    
    counter - name
    
    value - integer value
    
    Throws:
    
    Exception - if failure
  - RemoveCounter
```
void RemoveCounter(String name)
```
    Remove counter
    
    Parameters:
    
    name - of counter
  - GetVars
```
Enumeration GetVars()
```
    Returns an enumeration of all variables.
    
    Returns:
    
    Enumeration of all variables names
    
    See Also:
    
    ICS.SetVar(String,String), ICS.SetVar(String,int), ICS.GetVar(String), ICS.RemoveVar(String)
  - SetVar
```
void SetVar(String name,
            int value)
```
    Sets a variable to the specified value. If the variable does not exist, SetVar() creates it.
    
    Parameters:
    
    name - The name of the variable you wish to set.
    
    value - The value to set the variable to.
    
    See Also:
    
    ICS.GetVar(String), ICS.RemoveVar(String)
  - RemoveVar
```
void RemoveVar(String name)
```
    Removes a variable. After a variable is removed it is no longer defined for the processing of the page and its value cannot be referenced.
    
    Parameters:
    
    name - The name of the variable to delete.
    
    See Also:
    
    ICS.SetVar(String,String), ICS.SetVar(String,int), ICS.GetVar(String)
  - SetSSVar
```
void SetSSVar(String name,
              String value)
```
    Sets a session variable to the specified value. If the session variable does not exist, setSSVar() creates it.
    
    Parameters:
    
    name - The name of the session variable you wish to set.
    
    value - The value to set the session variable to.
    
    See Also:
    
    ICS.GetSSVar(String), ICS.RemoveSSVar(String)
  - GetSSVar
```
String GetSSVar(String name)
```
    Returns the value of a session variable. If the session variable does not exist, returns null.
    
    Parameters:
    
    name - The name of the session variable.
    
    Returns:
    
    The value of the session variable.
    
    See Also:
    
    ICS.SetSSVar(String,String), ICS.SetSSVar(String,int), ICS.RemoveSSVar(String)
  - GetSSVars
```
Enumeration GetSSVars()
```
    Returns an enumeration of all session variables.
    
    Returns:
    
    Enumeration of all session variable names
    
    See Also:
    
    ICS.SetSSVar(String,String), ICS.SetSSVar(String,int), ICS.GetSSVar(String), ICS.RemoveSSVar(String)
  - SetSSVar
```
void SetSSVar(String name,
              int value)
```
    Sets a session variable to the specified value. If the session variable does not exist, setSSVar() creates it.
    
    Parameters:
    
    name - The name of the session variable you wish to set.
    
    value - The value to set the session variable to.
    
    See Also:
    
    ICS.GetSSVar(String), ICS.RemoveSSVar(String)
  - RemoveSSVar
```
void RemoveSSVar(String name)
```
    Removes a session variable. After a session variable is removed it is no longer defined for the processing of the page and its value cannot be referenced.
    
    Parameters:
    
    name - The name of the session variable to delete.
    
    See Also:
    
    ICS.SetSSVar(String,String), ICS.SetSSVar(String,int), ICS.GetSSVar(String)
  - SessionID
```
String SessionID()
```
    Find out the session id being used by this user session. App server dependent form and size (length).
    
    Returns:
    
    string - may be null if sessions inactive or other error.
  - IsSystemSecure
```
boolean IsSystemSecure()
```
    Return if the current thread is running with CS security on or off - depends on property file setting and if off, no access restrictions will be in place at the core catalog level
    
    Returns:
    
    true if security is enabled, false it not
    
    Since:
    
    4.0
  - SetVar
```
void SetVar(String name,
            FTVAL value)
```
    Sets a variable to the specified value. If the variable does not exist, SetVar() creates it.
    
    Parameters:
    
    name - The name of the variable you wish to set.
    
    value - The value to set the variable to.
    
    Since:
    
    4.0
    
    See Also:
    
    ICS.GetCgi(String), ICS.RemoveVar(String)
  - GetCgi
```
FTVAL GetCgi(String name)
```
    Gets variable value even if the value is binary.
    
    Parameters:
    
    name - The name of the variable you wish to get.
    
    Returns:
    
    FTVAL value of the variable or null if it is not defined.
    
    See Also:
    
    ICS.GetVar(String), ICS.SetVar(String,FTVAL), ICS.GetBin(String)
  - GetProperty
```
String GetProperty(String name)
```
    Gets a property from the ContentServer property file.
    
    Parameters:
    
    name - The name of the property you wish to get.
    
    Returns:
    
    The value of the property. The value of passwords will remain encrypted.
    
    See Also:
    
    ICS.GetProperty(String,String,boolean), ICS.LoadProperty(String), ICS.RestoreProperty(boolean)
  - GetProperty
```
String GetProperty(String name,
                   String files,
                   boolean append)
```
    Gets a property from the a property file set.
    
    Parameters:
    
    name - The name of the property you wish to get.
    
    files - The semicolon separated list of property files.
    
    append - Set to true to append to the current property files. If this value is set to false, all of the required properties for Content Server must be specified in the properties named in files
    
    Returns:
    
    The value of the property. The value of passwords will remain encrypted.
    
    Since:
    
    4.0
    
    See Also:
    
    ICS.GetProperty(String), ICS.LoadProperty(String), ICS.RestoreProperty(boolean)
  - IsElement
```
boolean IsElement(String element)
```
    Checks for the existance of an element.
    
    Parameters:
    
    element - The name of the element.
    
    Returns:
    
    Returns true on success, false on failure.
  - getElementArgumentValue
```
String getElementArgumentValue(String element,
                               String argument)
```
    Retrieves the argument value of an element.
    
    Parameters:
    
    element - The name of the element.
    
    argument - The argument.
    
    Returns:
    
    Returns argument value.
  - GetCatalogType
```
int GetCatalogType(String catalog)
```
    Gets the type of a catalog.
    
    Parameters:
    
    catalog - The name of the catalog.
    
    Returns:
    
    Returns the catalog type (ContentCatalog, ObjectCatalog, TreeCatalog, ForeignCatalog, SystemCatalog, etc.).
  - IsTracked
```
boolean IsTracked(String catalog)
```
    Checks if a catalog is revision tracked.
    
    Parameters:
    
    catalog - The name of the catalog.
    
    Returns:
    
    Returns true if the catalog is revision tracked, else it return false.
  - IsTrackedNewFormat
```
boolean IsTrackedNewFormat(String catalog)
```
    Checks if a catalog is revision tracked with the new 8.0 format.
    
    Parameters:
    
    catalog - The name of the catalog.
    
    Returns:
    
    Returns true if the catalog is revision tracked, else it return false.
  - getTrackingStatus
```
int getTrackingStatus(String sTable,
                      String sId)
```
    Method to get the tracking status for a row in a table
    
    Parameters:
    
    sTable - name of the table
    
    sId - row identifier
    
    Returns:
    
    int status code
    
    Since:
    
    6.0
  - FlushCatalog
```
boolean FlushCatalog(String catname)
```
    Flushes any cached information on a named catalog.
    
    Parameters:
    
    catname - The name of the catalog to flush.
    
    Returns:
    
    Returns true on success, false on failure. Use GetErrno() to view the error.
  - GetErrno
```
int GetErrno()
```
    Returns the current error code.
    
    Returns:
    
    Current errno. Numbers less than 0 are errors.
    
    See Also:
    
    ICS.ClearErrno()
  - getComplexError
```
ftErrors getComplexError()
```
    Get error details in the form of COM.FutureTense.Util.ftErrors. Useful methods in this object are ftErrors.getError(), ftErrors.detail(int) (with ftErrors.details()) and ftErrors.getReason().
    
    Returns:
    
    ftErrors
    
    See Also:
    
    ftErrors.getError(), ftErrors.getReason(), ftErrors.details(), ftErrors.detail(int)
  - setComplexError
```
void setComplexError(ftErrors error)
```
    Set a complex error using COM.FutureTense.Util.ftErrors
    
    Parameters:
    
    error - ftErrors error object
  - SetErrno
```
void SetErrno(int i)
```
    Set the current error code as an integer. Please note, in order to avoid setting error codes which may interfere with the built in ContentServer codes, make sure all error codes are set to: (ftErrors.maxErrno + yourErrno) where "yourErrno" is a negative integer.
    
    Parameters:
    
    i - the integer error code to set
    
    See Also:
    
    ICS.ClearErrno(), ICS.GetErrno()
  - ClearErrno
```
void ClearErrno()
```
    Clears the current error code, setting it to 0. It is usefull to call this method immediately before executing a function which may alter the errno, to avoid confusion.
    
    See Also:
    
    ICS.GetErrno()
  - ResolveVariables
```
String ResolveVariables(String st)
```
    Resolves any variable, query column value, counter or property in this string. For example, if passed the string "This is the year: CS.Year", the return string will be "This is the year: 2000". Users may find resolveVariables() helpful to resolve ContentServer built-in values. This method is identical to ResolveVariables(st, true).
    
    Parameters:
    
    st - The String to resolve variable references for.
    
    Returns:
    
    The resolved String
    
    See Also:
    
    ICS.ResolveVariables(String,boolean)
  - ResolveVariables
```
String ResolveVariables(String st,
                        boolean bNew)
```
    Resolves any variable, query column value, counter or property in this string. For example, if passed the string "This is the year: CS.Year", the return string will be "This is the year: 2000". Users may find resolveVariables() helpful to resolve ContentServer built-in values.
    
    Parameters:
    
    st - The String to resolve variables for
    
    bNew - true to use the newer variable resolution syntax, false to use the older.
    
    Returns:
    
    The resolved String
  - SelectTo
```
IList SelectTo(String from,
               String what,
               String where,
               String orderby,
               int limit,
               String listname,
               boolean bCache,
               StringBuffer errstr)
```
    Performs a simple query by specifing a list of column names to return, and a list of column names to use as filtering. Dependant on variables in scope. Note that regardless of the value of bCache, the existing cache will be used in the return value. bCache only prevents new resultsets from being cached. This method is analogous to the XML SELECTO command.
    
    Parameters:
    
    from - Tablename to select.
    
    what - Column list, as in tblname,systable; is all columns.
    
    where - Comma-separated list of catalog columns to select against. For each item in the WHERE string, the value of the corresponding variable is used to construct a SQL WHERE clause.
    
    orderby - Column list defining the ordering of the results.
    
    limit - Maximum number of results, -1 means no limit.
    
    listname - List name to present to XML side for processing; if null is passed, a generic name will be assigned.
    
    bCache - True to cache the results; false to avoid caching the result.
    
    errstr - For return values; may contain error information.
    
    Returns:
    
    IList object containing the results. If IList is null, use GetErrno() to find the error. Note that the data is copied from the database to the returned IList, and the database connection is released immediately.
    
    See Also:
    
    ICS.CallSQL(String,String,int,boolean,boolean,StringBuffer), ICS.SQL(String,String,String,int,boolean,boolean,StringBuffer)
  - CallSQL
```
IList CallSQL(String qryname,
              String listname,
              int limit,
              boolean bLoadCache,
              StringBuffer errstr)
```
    Executes a stored SQL statement. Note that regardless of the value of bCache, the existing cache will be used in the return value. bCache only prevents new resultsets from being cached. This method is analagous to the XML CALLSQL ; command.
    
    Parameters:
    
    qryname - The name of the SQL element in the SystemSQL table.
    
    listname - List name to present to XML side for processing; if null is passed, a generic name will be assigned.
    
    limit - Maximum number of results, -1 means no limit.
    
    bLoadCache - True to completely load and cache the result set; otherwise the database connection is left open.
    
    errstr - For return values; may contain error information.
    
    Returns:
    
    IList object containing the results. If IList is null, use GetErrno() to find the error.
    
    See Also:
    
    ICS.SelectTo(String,String,String,String,int,String,boolean, StringBuffer), ICS.SQL(String,String,String,int,boolean,boolean,StringBuffer)
  - getSQL
```
String getSQL(String qryname)
```
    Method to get the SQL String given the query name
    
    Parameters:
    
    qryname - The name of the query
    
    Returns:
    
    The SQL for the given query.
  - CallSQL
```
IList CallSQL(String qryname,
              String listname,
              int limit,
              boolean bCache,
              boolean bLoad,
              StringBuffer errstr)
```
    Executes a stored SQL statement. Note that regardless of the value of bCache, the existing cache will be used in the return value. bCache only prevents new resultsets from being cached. This method is analagous to the XML CALLSQL ; command.
    
    Parameters:
    
    qryname - The name of the SQL element in the SystemSQL table.
    
    listname - List name to present to XML side for processing; if null is passed, a generic name will be assigned.
    
    limit - Maximum number of results, -1 means no limit.
    
    bCache - True to cache the result set; false otherwise.
    
    bLoad - True to completely load the result set; otherwise the database connection is left open.
    
    errstr - For return values; may contain error information.
    
    Returns:
    
    IList object containing the results. If IList is null, use GetErrno() to find the error.
    
    Since:
    
    6.0
    
    See Also:
    
    ICS.SelectTo(String,String,String,String,int,String,boolean, StringBuffer), ICS.SQL(String,String,String,int,boolean,boolean,StringBuffer)
  - SQL
```
IList SQL(String from,
          String sqlstmt,
          String listname,
          int limit,
          boolean bLoadCache,
          StringBuffer errstr)
```
    Executes an SQL statement. May be data base specific. Note that regardless of the value of bCache, the existing cache will be used in the return value. bCache only prevents new resultsets from being cached. This method is analgous to the XML EXECSQL ; command.
    
    Parameters:
    
    from - Comma separated list of table names this query will be cached against
    
    sqlstmt - The SQL statement to execute.
    
    listname - List name to present to XML side for processing; if null is passed, a generic name will be assigned.
    
    limit - Maximum number of results, -1 means no limit.
    
    bLoadCache - True to completely load and cache the result set; otherwise the database connection is left open.
    
    errstr - For return values; may contain error information.
    
    Returns:
    
    IList object containing the results. If IList is null, use GetErrno() to find the error.
  - SQL
```
IList SQL(String from,
          String sqlstmt,
          String listname,
          int limit,
          boolean bCache,
          boolean bLoad,
          StringBuffer errstr)
```
    Executes an SQL statement. May be data base specific. Note that regardless of the value of bCache, the existing cache will be used in the return value. bCache only prevents new resultsets from being cached. This method is analgous to the XML <EXECSQL> command.
    
    Parameters:
    
    from - Comma separated list of table names this query will be cached against
    
    sqlstmt - The SQL statement to execute.
    
    listname - List name to present to XML side for processing; if null is passed, a generic name will be assigned.
    
    limit - Maximum number of results, -1 means no limit.
    
    bCache - True to cache the result set; false otherwise.
    
    bLoad - True to completely load the result set; otherwise the database connection is left open.
    
    errstr - For return values; may contain error information.
    
    Returns:
    
    IList object containing the results. If IList is null, use GetErrno() to find the error.
    
    Since:
    
    6.0
  - SQL
```
IList SQL(PreparedStmt stmt,
          com.fatwire.cs.core.db.StatementParam data,
          boolean bCache)
```
    Executes a given PreparedStmt with supplied data; returns data in the form of an IList. The results will be cached if requested ( bCache = true ). Results are always looked up from the cache. Resulting data is fully loaded into the resulting IList before returning to the caller. ***************** Important Note ********************* Usage of this API is slightly different from other database accesss methods in this class. Please consider the following before using this method. 1. This class can be used only from Java API. There is no accessor to this functionality from XML tags or JSP tags. 2. This function throws Exceptions to communicate failure, in addition to setting error coded (like the rest of the APIs). Specific exceptions are documented above, users are expected to react by inspecing the error code once an exception is encountered. 3. This method does not set a 'list' in the ICS variable space.
    
    Parameters:
    
    stmt - Instance of PreparedStmt that will be executed (after resolving all SQL types for its placeholders)
    
    data - Instance of StatementParam belonging to the PreparedStmt. null is acceptable when PreparedStmt instance contains no placeholders (no ? characters in its statement).
    
    bCache - true to cache the result set; false otherwise (data will always be read from cache, when available, regardless of the value for bCache.)
    
    Returns:
    
    IList of results of execution, can be null.
    
    Throws:
    
    IllegalArgumentException - - if PreparedStmt, StatementParam are null (when not allowed) or incomplete (isComplete() = false) or number of placeholders are not equal ( PreparedStmt.getPositionsCount != StatementParam.getPositionsCount)
    
    IllegalStateException - - if the current user does not have permission (ACLs) to the tables used in the prepared statement or if table/column name specified could not be found. app.setError() is set for situations that results in any of these errors.
    
    RuntimeException - if execution of statement fails. Exceptions simply communicate the failure to the caller.
  - literal
```
String literal(String sTable,
               String sColumn,
               String sValue)
```
    Generates a literal value specific to a column in a table.
    
    Parameters:
    
    sTable - the table which contains the column
    
    sColumn - the name of the column
    
    sValue - the value to be converted to a literal
    
    Returns:
    
    string containing the generated literal or null on error
    
    Since:
    
    5.0
    
    See Also:
    
    ICS.SQLExp(String,String,String,String,String), ICS.SQLExp(String,String,String,String,String,String)
  - SQLExp
```
String SQLExp(String table,
              String type,
              String verb,
              String arg,
              String column)
```
    Generates an expression for an SQL WHERE clause This method is analgous to the XML <SQLExp> command.
    Parameters:
    
    table - The table for which the statement is being executed.
    type - The expression type. Legal values are:
    
    ICS.SQLExpAND
    
    ICS.SQLExpOR
    
    ICS.SQLExpIN
    verb - The verb for the where clause (e.g. "LIKE", "=", "!=", "IN", "NOT IN")
    
    arg - Comma separated list of values for the expression
    
    column - The column for which the expression is being generated
    
    Returns:
    
    String containing the generated expression.
  - SQLExp
```
String SQLExp(String table,
              String type,
              String verb,
              String arg,
              String column,
              String expression)
```
    Generates an expression for an SQL WHERE clause
    Parameters:
    
    table - The table for which the statement is being executed.
    type - The expression type. Legal values are:
    
    ICS.SQLExpAND
    
    ICS.SQLExpOR
    
    ICS.SQLExpIN
    verb - The verb for the where clause (e.g. "LIKE", "=", "!=", "IN", "NOT IN")
    
    arg - Comma separated list of values for the expression
    
    column - The column for which the expression is being generated
    
    expression - The optional column expression for which the expression is being generated
    
    Returns:
    
    String containing the generated expression.
    
    Since:
    
    5.0
  - CatalogDef
```
IList CatalogDef(String from,
                 String listname,
                 StringBuffer errstr)
```
    Queries a catalog for its column definition and stores the results in a list. The list contains a row for each column in the catalog.
    
    Parameters:
    
    from - The name of the catalog.
    
    listname - List name to present to XML side for processing; if null is passed, a generic name will be assigned.
    
    errstr - For return values; may contain error information.
    
    Returns:
    
    IList object containing the results. If IList is null, use GetErrno() to find the error.
  - CatalogIndexDef
```
IList CatalogIndexDef(String from,
                      String listname,
                      StringBuffer errstr)
```
    Queries a catalog for its index definition and stores the results in a list. The list contains a row for each column in the catalog.
    
    Parameters:
    
    from - The name of the catalog.
    
    listname - The list name for xml/jsp tags processing.
    
    errstr - For return values; may contain error information.
    
    Returns:
    
    a list
  - GetList
```
IList GetList(String listname)
```
    The GetList method retrieves the IList object for the given list name. This method does not create a list, it retrieves an existing list from among those known to Content Server. The IList is positioned at the first row.
    
    Parameters:
    
    listname - The name of the list you wish to return.
    
    Returns:
    
    The requested IList, or null if it does not exist.
    
    See Also:
    
    ICS.GetList(String,boolean), ICS.RegisterList(String,IList)
  - GetList
```
IList GetList(String listname,
              boolean reset)
```
    The GetList method retrieves the IList object for the given list name. This method does not create a list, it retrieves an existing list from among those known to Content Server.
    
    Parameters:
    
    listname - The name of the list you wish to return.
    
    reset - set to true to position at first row, otherwise the current list position will be maintained.
    
    Returns:
    
    The requested IList, or null if it does not exist.
    
    See Also:
    
    ICS.GetList(String), ICS.RegisterList(String,IList)
  - RenameList
```
boolean RenameList(String list,
                   String newname)
```
    Renames a list object.
    Renaming to a list that already exists destroys the existing list. Cached resultsets corresponding to the list, however, are not destroyed, and are accesible to other threads. To delete cached resultsets, use FlushCatalog(String).
    
    Parameters:
    
    list - The list to rename.
    
    newname - The new name for the list.
    
    Returns:
    
    Returns true/false for success/failure.
  - CopyList
```
boolean CopyList(String list,
                 String newname)
```
    Copies a list object. Copying to a list that already exists destroys the existing list. Cached resultsets corresponding to the list, however, are not destroyed, and are accesible to other threads. To delete cached resultsets, use FlushCatalog(String).
    
    Parameters:
    
    list - The list to copy.
    
    newname - The new name for the list.
    
    Returns:
    
    Returns true/false for success/failure.
  - CatalogManager
```
boolean CatalogManager(FTValList lin)
```
    Executes the Catalog Manager logic class This method is analogous to the XML <CATALOGMANAGER> command. See the tag reference guide for details about the possible parameters.
    
    Parameters:
    
    lin - FTValList values to use for new engine, a null indicates to use CGI values of Content Server
    
    Returns:
    
    Returns true or false if manager call worked. Use GetErrno() to check return codes from the call.
  - CatalogManager
```
boolean CatalogManager(FTValList lin,
                       Object oBatchContext)
```
    Executes the Catalog Manager logic class This method is analogous to the XML <CATALOGMANAGER> command. See the tag reference guide for details about the possible parameters
    
    Parameters:
    
    lin - FTValList values to use for new engine, a null indicates to use CGI values of Content Server
    
    oBatchContext - Object handle to the batch context object
    
    Returns:
    
    Returns true or false if manager call worked. Use GetErrno() to check return codes from the call.
  - TreeManager
```
boolean TreeManager(FTValList lin)
```
    Executes the Tree Manager logic class This method is analogous to the XML <TREEMANAGER> command. See the tag reference guide for details about the possible parameters
    
    Parameters:
    
    lin - FTValList values to use for new engine, a null indicates to use CGI values of Content Server
    
    Returns:
    
    Returns true or false if manager call worked. Use GetErrno() to check return codes from the call.
  - TreeManager
```
boolean TreeManager(FTValList lin,
                    Object oBatchContext)
```
    Executes the Tree Manager logic class This method is analogous to the XML <TREEMANAGER> command. See the tag reference guide for details about the possible parameters
    
    Parameters:
    
    lin - FTValList values to use for new engine, a null indicates to use CGI values of Content Server
    
    oBatchContext - Object handle to the batch context object
    
    Returns:
    
    Returns true or false if manager call worked. Use GetErrno() to check return codes from the call.
  - CallElement
```
boolean CallElement(String elementname,
                    FTValList lin)
```
    Executes a registered element. When the element is called, the resulting output is immediately streamed to STDOUT.
    
    Parameters:
    
    elementname - The name of the element to call.
    
    lin - Name/value pairs to be passed to the element as arguments. If null, then only variables in the current variable scope will be passed. If values are specified, then they will be set into the current variable scope, overwriting any existing variables with the same names, and then the element will be called.
    
    Returns:
    
    Returns true or false if element was invoked successfully, false if the element could not be executed.
  - StreamEvalBytes
```
void StreamEvalBytes(String msg)
```
    Writes a string to the current element evaluation stream; it will be appended to the current element output buffer.
    
    Parameters:
    
    msg - String msg
  - ReadPage
```
String ReadPage(String pagename,
                FTValList lin)
```
    Invokes a pagelet through Content Server. This creates a new Content Server instance. The output returned as a String.
    
    Parameters:
    
    pagename - pagename entry in the SiteCatalog.
    
    lin - Name/Value pairs to be passed as input parameters to the page. If the pagelet is to be cached (according to the SiteCatalog) then all of the variables passed should be listed in the pagecriteria column. If null is passed, then the current variable scope is passed. It is strongly recommended that a non-null value be passed here to ensure explicit control over the cache key.
    
    Returns:
    
    Returns a String containing the resulting output; or null on an error. If an error occurs, errno will be set appropriately
    
    See Also:
    
    ICS.GetErrno()
  - InsertPage
```
boolean InsertPage(String pagename,
                   FTValList lin)
```
    Invokes a pagelet inline with the current evaluation. Creates a new Content Server instance and evaluates the page in context. The resulting output is streamed as if included inline
    
    Parameters:
    
    pagename - pagename entry in the SiteCatalog.
    
    lin - Name/Value pairs to be passed as input parameters to the page. If the pagelet is to be cached (according to the SiteCatalog) then all of the variables passed should be listed in the pagecriteria column. If null is passed, then the current variable scope is passed. It is strongly recommended that a non-null value be passed here to ensure explicit control over the cache key.
    
    Returns:
    
    boolean. If an error occurs, errno will be set appropriately
    
    See Also:
    
    ICS.GetErrno()
  - NewSeedFromTagname
```
Seed NewSeedFromTagname(String tagname)
```
    Deprecated. use ICS.runTag(String, FTValList) instead
    
    Return the Seed class which implements a given dynamic tag; may return null if the tag is not implemented dynamically or is undefined in the runtime system. Example use Seed s = ics.NewSeedFromTagname("Mytag"); if (s!=null) s.Execute(vIn, vOut);
    
    Parameters:
    
    tagname - (caseless)
    
    Returns:
    
    class instance or null
    
    See Also:
    
    ICS.runTag(String,FTValList)
  - runTag
```
String runTag(String sTag,
              FTValList vIn)
```
    Method to execute a simple XML tag by name. The XML tag connot expect any nested child tags, and so it must be a singleton tag.
    
    Parameters:
    
    sTag - name of the tag
    
    vIn - input key/value pairs
    
    Returns:
    
    output string or null errno set on error
    
    Since:
    
    5.0
  - StreamText
```
void StreamText(String text)
```
    Immediately streams text out to the ICS context (RIGHT NOW). This is unbuffered output, and as such may appear before text already in the element's buffered output stream is flushed. Bytes that are output through this method are not subject to page caching. As such, it should be used with caution.
    
    Parameters:
    
    text - The text to stream.
  - FlushStream
```
void FlushStream()
```
    Flush the output stream of pending data (not stuff in cache for page)
  - StreamBinary
```
void StreamBinary(byte[] b,
                  int offset,
                  int length)
```
    Deprecated.
    
    Immediately streams binary out to the ICS context (RIGHT NOW). This is unbuffered output, and as such may appear before text already in the element's buffered output stream is flushed. Bytes that are output through this method are not subject to page caching. As such, it should be used with caution. Note that if binary data is not supported in the current execution context, nothing will be streamed an an error will be logged.
    
    Parameters:
    
    b - byte array to stream
    
    offset - offset into byte array
    
    length - number of bytes to stream
  - StreamHeader
```
void StreamHeader(String header,
                  String text)
```
    Immediately stream header data. Once non header data has been sent, this is a no-op.
    
    Parameters:
    
    header - String name of header (ie content-type)
    
    text - String header data (ie image/gif)
  - grabHeaders
```
FTValList grabHeaders()
```
    Get headers set since last call
    
    Returns:
    
    hashmap of any headers set by the current execution thread since the last call
    
    Since:
    
    5.0
  - grabCacheStatus
```
byte[] grabCacheStatus()
```
    get the cache status
    
    Returns:
    
    cache status
    
    Since:
    
    4.0
  - LoadProperty
```
boolean LoadProperty(String name)
```
    Loads a new property set into the system.
    
    Parameters:
    
    name - The name of the property set to load (i.e. "futuretense.ini").
    
    Returns:
    
    Returns true on success, false on failure.
  - RestoreProperty
```
boolean RestoreProperty(boolean bClose)
```
    Restores the previous property set into the system.
    
    Parameters:
    
    bClose - Whether to close the connection to a database opened using the current properties. Possible values are "true" or "false". If bClose is set to "true" any open database connection specified by the current properties will be closed before restoring the defaults. This invalidates any active, uncached resultsets connected to that database. If access to those resultsets is required after restoreProperty(), bClose should be set to "false". This will keep the connection open and resultsets against the database will be available.
    
    Returns:
    
    Returns true on success, false on failure.
  - getCookie
```
String getCookie(String sName)
```
    Get the value of a cookie from the header
    
    Parameters:
    
    sName - cookie name
    
    Returns:
    
    cookie value or null if no such cookie
    
    Since:
    
    5.5
  - SetCookie
```
boolean SetCookie(String name,
                  String value,
                  int timeout,
                  String url,
                  String domain,
                  boolean bSecure)
```
    Sets or removes a cookie. If the HTTP headers have already been committed, then this function is a no-op.
    
    Parameters:
    
    name - The name of the cookie to set.
    
    value - The value to set the cookie to. Setting the value to null REMOVES the cookie.
    
    timeout - The timeout period for the cookie on the client, in seconds.
    
    url - Valid URL. This value restricts the sending of the cookie from the client to this URL only. Defaults to "/" if omitted.
    
    domain - Valid domain name. This value restricts the sending of the cookie from the client to addresses in this domain only.
    
    bSecure - Indicates whether security is set on this cookie.
    
    Returns:
    
    Returns true on success, false on failure.
  - DisableCache
```
void DisableCache()
```
    Disables any caching of the current execution thread. Use this method when an error is detected in the page that should prevent it from being cached. If the current page was to be cached, and the current thread is the one that has been elected to render the page, then all other threads will be blocked while this thread completes execution of the page. Therefore, calling this method regularly will effectively render the system single-threaded... so it should be used very carefully. This function disables caching of the current pagelet, all of its parent pagelets, and also any child pagelets. Use ICS.DisableFragmentCache() to disable caching for the current pagelet and its parents, but to allow caching of child pagelets that have not yet been executed.
    
    See Also:
    
    ICS.DisableFragmentCache()
  - SendMail
```
boolean SendMail(String to,
                 String subject,
                 String body,
                 String replyto,
                 String contenttype,
                 String charset,
                 FTValList attachments)
```
    Sends an email to the specified address.
    
    Parameters:
    
    to - A valid TO value, i.e. "joe@somecompany.com".
    
    subject - The subject of the message. May be null if the body is not null.
    
    body - The message body. May be null if the subject is not null.
    
    replyto - The replyto address for the message. May be null to use the same address as from.
    
    contenttype - The content-type for the message. May be null to default to text/plain
    
    charset - The charset for the message. May be null if body contains only US-ASCII characters or contenttype contains charset.
    
    attachments - The attachments associated with this message. Attachmaent names are passed as keys and actual attachments are passed as values, each attachment is encapsulated in object FTVAL.
    
    Returns:
    
    Returns true on success, false on failure.
  - SendMail
```
boolean SendMail(String to,
                 String subject,
                 String body,
                 String replyto,
                 String contenttype)
```
    Sends an email to the specified address.
    
    Parameters:
    
    to - A valid TO value, i.e. "joe@somecompany.com".
    
    subject - The subject of the message. May be null if the body is not null.
    
    body - The message body. May be null if the subject is not null.
    
    replyto - The replyto address for the message. May be null to use the same address as from.
    
    contenttype - The content-type for the message. May be null to default to text/plain
    
    Returns:
    
    Returns true on success, false on failure.
  - SendMail
```
boolean SendMail(String to,
                 String subject,
                 String body)
```
    Sends an email to the specified address.
    
    Parameters:
    
    to - A valid TO value, i.e. "joe@somecompany.com".
    
    subject - The subject of the message. May be null if the body is not null.
    
    body - The message body. May be null if the subject is not null.
    
    Returns:
    
    Returns true on success, false on failure.
  - UserIsMember
```
boolean UserIsMember(String grouplist)
```
    Determines if the currently logged in user is a member of a supplied group.
    
    Parameters:
    
    grouplist - A comma seperated list of groups to check against.
    
    Returns:
    
    Returns true if the user is a member, false if not.
  - LogMsg
```
void LogMsg(String msg)
```
    Deprecated. Use Apache's commons-logging module instead. Out of the box Logger names are identified in ftMessage.
    
    Logs an informational message to the Content Server log file. This method is analogous to the XML <LOGMSG> command. Messages are logged to the generic logger with a severity of INFO.
    
    Parameters:
    
    msg - The message to send to the Content Server log file.
  - GetSearchEngine
```
COM.FutureTense.Interfaces.ISearchEngine GetSearchEngine(String sEngine,
                                                         String sCharset,
                                                         StringBuffer errstr)
```
    Get an instance of the specified search engine. This method is currently for internal use only.
    
    Parameters:
    
    sEngine - Search engine name. May be null.
    
    sCharset - Search index charset. May be null.
    
    errstr - For return values; may contain error information.
    
    Returns:
    
    Returns the search engine on success, null on failure.
  - GetSearchEngineList
```
String GetSearchEngineList()
```
    Get a string list of the available search engines. This method is currently for internal use only.
    
    Returns:
    
    Returns a semi-colon separated list of available search engines. May be empty string.
  - IndexCreate
```
boolean IndexCreate(String sIndex,
                    FTValList vlFieldArguments,
                    String sEngine,
                    String sCharset,
                    StringBuffer errstr)
```
    Creates a search index.
    
    Parameters:
    
    sIndex - Full path name to the index to create. May be null.
    
    vlFieldArguments - Field argument names and values. May be null.
    
    sEngine - Search engine name. May be null.
    
    sCharset - Search index charset. May be null.
    
    errstr - For return values; may contain error information.
    
    Returns:
    
    Returns true on success, false on failure.
  - IndexDestroy
```
boolean IndexDestroy(String sIndex,
                     String sEngine,
                     String sCharset,
                     StringBuffer sbError)
```
    Deletes a search index.
    
    Parameters:
    
    sIndex - Search index to destroy. May be null.
    
    sEngine - Search engine name. May be null.
    
    sCharset - Search index charset. May be null.
    
    sbError - For return values; may contain error information.
    
    Returns:
    
    Returns true on success, false on failure.
  - IndexExists
```
boolean IndexExists(String sIndex,
                    String sEngine,
                    String sCharset,
                    StringBuffer sbError)
```
    Checks for the existence a search index.
    
    Parameters:
    
    sIndex - Search index to destroy. May be null.
    
    sEngine - Search engine name. May be null.
    
    sCharset - Search index charset. May be null.
    
    sbError - For return values; may contain error information.
    
    Returns:
    
    Returns true if the index exists, false otherwise.
  - IndexAdd
```
boolean IndexAdd(String sIndex,
                 String sEntryName,
                 String sEntryDetail,
                 String sWordList,
                 String sWordListDelimiters,
                 String sFileList,
                 String sDate,
                 FTValList vlTextArguments,
                 FTValList vlFileArguments,
                 FTValList vlDateArguments,
                 String sEngine,
                 String sCharset,
                 StringBuffer sbError)
```
    Adds an item to the search index.
    
    Parameters:
    
    sIndex - The name of the search index. May be null.
    
    sEntryName - The name of the index entry to add.
    
    sEntryDetail - The detail string associated with entry. May be null.
    
    sWordList - The word list to index. May be null.
    
    sWordListDelimiters - The characters to use as word list delimiters. May be null.
    
    sFileList - A list of files to add. May be null.
    
    sDate - The date associated with this entry. May be null.
    
    vlTextArguments - The text argument names and values. May be null.
    
    vlFileArguments - The file argument names and values. May be null.
    
    vlDateArguments - The date argument names and values. May be null.
    
    sEngine - The search engine name. May be null.
    
    sCharset - The search index charset. May be null.
    
    sbError - For return values; may contain error information.
    
    Returns:
    
    Returns true on success, false on failure.
  - IndexReplace
```
boolean IndexReplace(String sIndex,
                     String sEntryName,
                     String sEntryDetail,
                     String sWordList,
                     String sWordListDelimiters,
                     String sFileList,
                     String sDate,
                     FTValList vlTextArguments,
                     FTValList vlFileArguments,
                     FTValList vlDateArguments,
                     String sEngine,
                     String sCharset,
                     StringBuffer sbError)
```
    Replaces an item in the search index.
    
    Parameters:
    
    sIndex - The name of the search index. May be null.
    
    sEntryName - The name of the index entry to replace.
    
    sEntryDetail - The detail string associated with entry. May be null.
    
    sWordList - The word list to index. May be null.
    
    sWordListDelimiters - The characters to use as word list delimiters. May be null.
    
    sFileList - A list of files to add. May be null.
    
    sDate - The date associated with this entry. May be null.
    
    vlTextArguments - The text argument names and values. May be null.
    
    vlFileArguments - The file argument names and values. May be null.
    
    vlDateArguments - The date argument names and values. May be null.
    
    sEngine - The search engine name. May be null.
    
    sCharset - The search index charset. May be null.
    
    sbError - For return values; may contain error information.
    
    Returns:
    
    Returns true on success, false on failure.
  - IndexRemove
```
boolean IndexRemove(String sIndex,
                    String sEntryName,
                    String sEngine,
                    String sCharset,
                    StringBuffer sbError)
```
    Removes a search index entry.
    
    Parameters:
    
    sIndex - The name of the index. May be null.
    
    sEntryName - The name of the entry to delete.
    
    sEngine - The search engine name. May be null.
    
    sCharset - The search index charset. May be null.
    
    sbError - For return values; may contain error information.
    
    Returns:
    
    Returns true on success, false on failure.
  - SearchDateToNative
```
boolean SearchDateToNative(String sDate,
                           StringBuffer sbOut,
                           String sEngine,
                           String sCharset,
                           StringBuffer sbError)
```
    Converts a javaSQL date string to native search engine format.
    
    Parameters:
    
    sDate - The date to convert.
    
    sbOut - Buffer to where the converted string will be returned.
    
    sEngine - The search engine name. May be null.
    
    sCharset - The search index charset. May be null.
    
    sbError - For return values; may contain error information.
    
    Returns:
    
    Returns true on success, false on failure.
  - Search
```
IList Search(String sIndex,
             String sWhat,
             String sRelevence,
             String sQueryParser,
             int nMaxResults,
             FTValList vlAdditionalIndexes,
             String sList,
             String sEngine,
             String sCharset,
             StringBuffer sbError)
```
    Searches an index.
    
    Parameters:
    
    sIndex - The index to search. May be null.
    
    sWhat - The query string.
    
    sRelevence - The Relevence string. May be null.
    
    sQueryParser - The query parser name. May be null.
    
    nMaxResults - The maximum number of results to return. Set this to 0 for unlimited results.
    
    vlAdditionalIndexes - The name, value pairs of additional indexes to search. May be null.
    
    sList - The name of the list. May be null.
    
    sEngine - The search engine name. May be null.
    
    sCharset - The search index charset. May be null.
    
    sbError - For return values; may contain error information.
    
    Returns:
    
    Returns the name/value pairs of the result set.
  - RTHistory
```
IList RTHistory(String sTable,
                String sAsset,
                String sVersion,
                String sLocker,
                String sCreator,
                String sAnnotation,
                String sListName)
```
    Returns revision history for rows in a revision tracked table. To obtain history for all rows, the current user must have rtaudit privileges on the table. If the current user has read privileges on the table, only history on the revisions which the user has created or locked will be returned.
    
    Parameters:
    
    sTable - Name of the tracked table.
    
    sAsset - Value of the primary key for the row whose history to retrieve.
    
    sVersion - requesed version
    
    sLocker - Filter rows returned based on a user who has rows locked. If the current user does not have rtaudit privileges, you must specify a value for LOCKER, CREATOR, or both. If you specify only LOCKER, the value must be the current users name; otherwise, no data will be returned.
    
    sCreator - Filter rows returned based on the user who created the row. If the current user does not have rtaudit privileges, you must specify a value for LOCKER, CREATOR, or both. If you specify only CREATOR, the value must be the current users name; otherwise, no data will be returned.
    
    sAnnotation - Filter rows returned based on the annotation of a row.
    
    sListName - Name of the list.
    
    Returns:
    
    List containing the returned results.
  - RTInfo
```
IList RTInfo(String sTable,
             String sListName)
```
    Returns information on tracked tables from the RTInfo table
    
    Parameters:
    
    sTable - Name of the tracked table
    
    sListName - Name of the IList to register.
    
    Returns:
    
    IList containing the returned results.
    
    Since:
    
    6.0
  - RTLock
```
int RTLock(String sTable,
           String sAsset)
```
    Locks a record by the current user in a tracked table. Once a row is locked, the current user can modify fields in the row. The current user must have write access to the table.
    
    Parameters:
    
    sTable - Name of the tracked table.
    
    sAsset - Value of the primary key of the row to lock.
    
    Returns:
    
    Returns the errno. If -1000, check the RT details error.
  - RTCommit
```
int RTCommit(String sTable,
             String sAsset,
             String sAnnotation,
             boolean bKeepLocked)
```
    Creates a new revision of a record from a tracked table. The current user must have the record locked and have write access to the tracked table to perform this operation.
    
    Parameters:
    
    sTable - Name of the tracked table.
    
    sAsset - Value of the primary key for the record being commited.
    
    sAnnotation - Comment describing the new revision.
    
    bKeepLocked - Indicates lock status of record after commit. Set value to "true" to indicate the record will still be locked by user after the commit.
    
    Returns:
    
    Returns the errno. If -1000, check the RT details error.
  - RTRelease
```
int RTRelease(String sTable,
              String sAsset)
```
    Release a lock on a row from a tracked table. Only the user who has the row locked against the table may release it. This will also revert the row in the table to its last committed state, overwriting any changes the user made while the row was locked.
    
    Parameters:
    
    sTable - Name of the tracked table.
    
    sAsset - Value of the primary key of the row to release.
    
    Returns:
    
    Returns the errno. If -1000, check the RT details error.
  - RTRetrieveRevision
```
IList RTRetrieveRevision(String strTableName,
                         String strAsset,
                         int nVersion,
                         String listName)
```
    This method returns a specific version for a tracked table. The results returned will be identical to a "select *" against the tracked table, assuming the table had been rolled back to the specified version.
    
    Parameters:
    
    strTableName - The name of the tracked table.
    
    strAsset - The asset to get the results for.
    
    nVersion - The version number of the edits.
    
    listName - The name of the list to store the results.
    
    Returns:
    
    Returns the list storing the results.
  - RTRetrieveRevision
```
IList RTRetrieveRevision(String strTableName,
                         String strAsset,
                         String strVersion,
                         String listName)
```
    This method returns a specific version for a tracked table. The results returned will be identical to a "select *" against the tracked table, assuming the table had been rolled back to the specified version. This version of the command allows a string version number, "first", "last", or a date (in the format of "YYYY-MM-DD 24HH:MI:SS"). "first" and "last" return the first and last revisions, while a date will return the revision that was or is current as of the specified date.
    
    Parameters:
    
    strTableName - The name of the tracked table.
    
    strAsset - The asset to get the results for.
    
    strVersion - The version number of the edits.
    
    listName - The name of the list that stores the results.
    
    Returns:
    
    Returns the list storing the results.
  - RegisterList
```
boolean RegisterList(String listname,
                     IList ilist)
```
    Register an IList object with CS for use in XML tagging; this assumes that the IList was created in a manner that did not implicitly register the name, as would be the case with the listname parameter to SQL(), SelectTo(), etc. NOTE if the supplied name is in use in the current scope, this list will replace the existing list object. NOTE also that if the same IList is known by CS under two different names, operations using one name will affect the other and may result in undefined behavior.
    
    Parameters:
    
    listname - list name to present to XML side for processing;
    
    ilist - list to register, setting to null unregisters an existing list.
    
    Returns:
    
    boolean list item added. Use GetErrno() to view the error. An error will be returned if the added list is empty (no rows) or invalid (no columns).
  - RTRollback
```
int RTRollback(String sTable,
               String sAsset,
               int nVersion)
```
    Reverts a row in a tracked table to a previous revision. The current user must have the row locked and have rtaudit privileges against the table to rollback the row. This version of RTRollback takes an integer version number to rollback to.
    
    Parameters:
    
    sTable - Name of the table containing row to revert to a previous version.
    
    sAsset - Value of the primary key for the row to revert to a previous version.
    
    nVersion - Version to make current.
    
    Returns:
    
    Returns the errno. If -1000, check the RT details error.
  - RTRollback
```
int RTRollback(String sTable,
               String sAsset,
               String strVersion)
```
    Reverts a row in a tracked table to a previous revision. The current user must have the row locked and have rtaudit privileges against the table to rollback the row. This version of the command allows a string version number, "first", "last", or a date (in the format of "YYYY-MM-DD 24HH:MI:SS"). "first" and "last" rollback to the first and last revisions, while a date will rollback the revision current as of the specified date.
    
    Parameters:
    
    sTable - Name of the table containing row to revert to a previous version.
    
    sAsset - Value of the primary key for the row to revert to a previous version.
    
    strVersion - Version to make current.
    
    Returns:
    
    Returns the errno. If -1000, check the RT details error.
  - RTTrackTable
```
int RTTrackTable(String sTable,
                 String sStorage,
                 int nVersions)
```
    Enables revision tracking operations on a table. The maximum number of revisions per row can be set as well as the storage location for the revisions.
    
    Parameters:
    
    sTable - Name of the table to track.
    
    sStorage - Location to store revisions associated with a row in the table. This is the root folder. A folder will be automatically created under the given root folder whose name is the same as the catalog being tracked
    
    nVersions - Maximum number of versions to store for each row. When the maximum is reached, the oldest version is removed.
    
    Returns:
    
    Returns the errno. If -1000, check the RT details error.
  - RTUntrackTable
```
int RTUntrackTable(String sTable)
```
    Stops tracking a table. Revision tracking operations will no longer be available on the table.
    
    Parameters:
    
    sTable - Name of the table to stop tracking.
    
    Returns:
    
    Returns the errno. If -1000, check the RT details error.
  - RTUnlockRecord
```
int RTUnlockRecord(String sTable,
                   String sAsset)
```
    Unlocks a locked row. Only the user who has the row locked or a user who has rtadmin privileges against the table may unlock the row. Does not restore the row to its most recent revision.
    
    Parameters:
    
    sTable - Name of the tracked table.
    
    sAsset - Value of the primary key of the row to unlock.
    
    Returns:
    
    Returns the errno. If -1000, check the RT details error.
  - RTDeleteRevision
```
int RTDeleteRevision(String sTable,
                     String sAsset,
                     int nVersion)
```
    Deletes a revision of a row from a tracked table. The current user must have rtadmin access to the tracked table to perform this operation. If the most recent revision is locked, deleting the most recent revision will also delete the lock on it
    
    Parameters:
    
    sTable - Name of the table containing row whose revision is to be deleted.
    
    sAsset - Value of the primary key for the row whose revision is to be deleted.
    
    nVersion - Version of the row to delete.
    
    Returns:
    
    Returns the errno. If -1000, check the RT details error.
  - RTSetVersions
```
int RTSetVersions(String sTable,
                  int nVersions)
```
    Sets the number of revisions stored for each row in a tracked table. The current user must have rtadmin privileges on the table.
    
    Parameters:
    
    sTable - Table to modify maximum number of versions.
    
    nVersions - Maximum number of versions to store for each row. When the maximum is reached, the oldest version is removed. A value of 0 (zero) indicates an unbounded number of versions will be stored. If the value is smaller than the current number of versions on the table, those versions will remain and can be removed manually.
    
    Returns:
    
    Returns the errno. If -1000, check the RT details error.
  - Mirror
```
int Mirror(Vector vILists,
           String sTarget,
           String sUsername,
           String sPassword,
           String sCGIPrefix,
           String sTargetIniFile,
           int nPort,
           boolean bUseProxy,
           boolean bUseHTTPS,
           int nHTTPVersion,
           StringBuffer sbOutput)
```
    Mirrors a result set.
    
    Parameters:
    
    vILists - Vector of IList objects to mirror
    
    sTarget - Target server name.
    
    sUsername - Username to use on the remote server. May be null.
    
    sPassword - Password to use on remote server. May be null.
    
    sCGIPrefix - CGI prefix string. May be null to indicate that the remote server is the same type as the source.
    
    sTargetIniFile - String property file to push to target server. May be null if no property file
    
    nPort - int port to use for communication. 0 interpreted the default HTTP port (80)
    
    bUseProxy - TRUE to use proxy server for connection. FALSE otherwise.
    
    bUseHTTPS - TRUE to use secure communcation. FALSE otherwise.
    
    nHTTPVersion - Version of HTTP protocol to be used to connect to remote server. Valid values are HTTPVERSION10 and HTTPVERSION11.
    
    sbOutput - Output for return values; may contain error info. May be null.
    
    Returns:
    
    Returns the errno.
  - Mirror
```
int Mirror(Vector vILists,
           String sTarget,
           String sUsername,
           String sPassword,
           String sCGIPrefix,
           String sTargetIniFile,
           int nPort,
           boolean bUseProxy,
           String proxyserver,
           String proxyport,
           String proxyuser,
           String proxypassword,
           boolean bUseHTTPS,
           int nHTTPVersion,
           StringBuffer sbOutput)
```
    Mirrors a result set.
    
    Parameters:
    
    vILists - Vector of IList objects to mirror
    
    sTarget - Target server name.
    
    sUsername - Username to use on the remote server. May be null.
    
    sPassword - Password to use on remote server. May be null.
    
    sCGIPrefix - CGI prefix string. May be null to indicate that the remote server is the same type as the source.
    
    sTargetIniFile - String property file to push to target server. May be null if no property file
    
    nPort - int port to use for communication. 0 interpreted the default HTTP port (80)
    
    bUseProxy - TRUE to use proxy server for connection. FALSE otherwise.
    
    proxyserver - Proxy server, if any
    
    proxyuser - Proxy user, if any
    
    proxypassword - Proxy password, if any
    
    proxyport - Proxy server port, if any
    
    bUseHTTPS - TRUE to use secure communcation. FALSE otherwise.
    
    nHTTPVersion - Version of HTTP protocol to be used to connect to remote server. Valid values are HTTPVERSION10 and HTTPVERSION11.
    
    sbOutput - Output for return values; may contain error info. May be null.
    
    Returns:
    
    Returns the errno.
  - Mirror
```
int Mirror(IList list,
           String sTarget,
           String sUsername,
           String sPassword,
           String sCGIPrefix,
           String sTargetIniFile,
           int nPort,
           boolean bUseProxy,
           String proxyserver,
           String proxyport,
           String proxyuser,
           String proxypassword,
           boolean bUseHTTPS,
           int nHTTPVersion,
           String tableToMirror,
           StringBuffer sbOutput)
```
    Mirrors a result set.
    
    Parameters:
    
    list - IList object to mirror
    
    sTarget - Target server name.
    
    sUsername - Username to use on the remote server. May be null.
    
    sPassword - Password to use on remote server. May be null.
    
    sCGIPrefix - CGI prefix string. May be null to indicate that the remote server is the same type as the source.
    
    sTargetIniFile - String property file to push to target server. May be null if no property file
    
    nPort - int port to use for communication. 0 interpreted the default HTTP port (80)
    
    bUseProxy - TRUE to use proxy server for connection. FALSE otherwise.
    
    bUseHTTPS - TRUE to use secure communcation. FALSE otherwise.
    
    nHTTPVersion - Version of HTTP protocol to be used to connect to remote server.
    
    proxyserver - Proxy server, if any
    
    proxyuser - Proxy user, if any
    
    proxypassword - Proxy password, if any
    
    proxyport - Proxy server port, if any Valid values are HTTPVERSION10 and HTTPVERSION11.
    
    tableToMirror - Table name from which the FSet was retrieved as a resultset.
    
    sbOutput - Output for return values; may contain error info. May be null.
    
    Returns:
    
    Returns the errno.
  - Mirror
```
int Mirror(Vector vILists,
           Vector vTreeList,
           String sTarget,
           String sUsername,
           String sPassword,
           String sCGIPrefix,
           String sTargetIniFile,
           int nPort,
           boolean bUseProxy,
           boolean bUseHTTPS,
           int nHTTPVersion,
           StringBuffer sbOutput)
```
    Mirrors a result set.
    
    Parameters:
    
    vILists - Vector of IList objects to mirror
    
    vTreeList - Vector of FTTreeNode objects to mirror
    
    sTarget - Target server name.
    
    sUsername - Username to use on the remote server. May be null.
    
    sPassword - Password to use on remote server. May be null.
    
    sCGIPrefix - CGI prefix string. May be null to indicate that the remote server is the same type as the source.
    
    sTargetIniFile - String property file to push to target server. May be null if no property file
    
    nPort - int port to use for communication. 0 interpreted the default HTTP port (80)
    
    bUseProxy - TRUE to use proxy server for connection. FALSE otherwise.
    
    bUseHTTPS - TRUE to use secure communcation. FALSE otherwise.
    
    nHTTPVersion - Version of HTTP protocol to be used to connect to remote server. Valid values are HTTPVERSION10 and HTTPVERSION11.
    
    sbOutput - Output for return values; may contain error info. May be null.
    
    Returns:
    
    Returns the errno.
  - Mirror
```
int Mirror(Vector vILists,
           Vector vTreeList,
           String sTarget,
           String sUsername,
           String sPassword,
           String sCGIPrefix,
           String sTargetIniFile,
           int nPort,
           boolean bUseProxy,
           String proxyserver,
           String proxyport,
           String proxyuser,
           String proxypassword,
           boolean bUseHTTPS,
           int nHTTPVersion,
           StringBuffer sbOutput)
```
    Mirrors a result set.
    
    Parameters:
    
    vILists - Vector of IList objects to mirror
    
    vTreeList - Vector of FTTreeNode objects to mirror
    
    sTarget - Target server name.
    
    sUsername - Username to use on the remote server. May be null.
    
    sPassword - Password to use on remote server. May be null.
    
    sCGIPrefix - CGI prefix string. May be null to indicate that the remote server is the same type as the source.
    
    sTargetIniFile - String property file to push to target server. May be null if no property file
    
    nPort - int port to use for communication. 0 interpreted the default HTTP port (80)
    
    bUseProxy - TRUE to use proxy server for connection. FALSE otherwise.
    
    proxyserver - Proxy server, if any
    
    proxyport - Proxy server port
    
    proxyuser - Proxy user, if any
    
    proxypassword - Proxy password, if any
    
    bUseHTTPS - TRUE to use secure communcation. FALSE otherwise.
    
    nHTTPVersion - Version of HTTP protocol to be used to connect to remote server. Valid values are HTTPVERSION10 and HTTPVERSION11.
    
    sbOutput - Output for return values; may contain error info. May be null.
    
    Returns:
    
    Returns the errno.
  - GetSynchronizedHash
```
ISyncHash GetSynchronizedHash(String name,
                              boolean bCreate,
                              int timeout,
                              int size,
                              boolean bAbsolute,
                              boolean bClusterSync)
```
    Locate/create a named synchronized hash
    
    Parameters:
    
    name - String hashname
    
    bCreate - boolean create - if true and hash not found it is created using following params. Existing hash always returned if found.
    
    timeout - timeout in minutes
    
    size - size of entries
    
    bAbsolute - absolute timeout vs idle
    
    bClusterSync - synchronize over cluster
    
    Returns:
    
    Object handle or null. NOTE that the hash name is not restricted to a given application (ie loaded property file). errno cleared or set if error. Note that creating a hash with size < 1 will return an error.
  - GetSynchronizedHash
```
ISyncHash GetSynchronizedHash(String name,
                              boolean bCreate,
                              int timeout,
                              int size,
                              boolean bAbsolute,
                              boolean bClusterSync,
                              Collection linked)
```
    Locate/create a named synchronized hash
    
    Parameters:
    
    name - String hashname
    
    bCreate - boolean create - if true and hash not found it is created using following params. Existing hash always returned if found.
    
    timeout - timeout in minutes
    
    size - size of entries
    
    bAbsolute - absolute timeout vs idle
    
    bClusterSync - synchronize over cluster
    
    linked - Collection of caches that this ISyncHash is "linked" to. when these linked caches are cleared, this ISyncHash will also get cleared.
    
    Returns:
    
    Object handle or null. NOTE that the hash name is not restricted to a given application (ie loaded property file). errno cleared or set if error. Note that creating a hash with size less than 1 will return an error.
    
    Since:
    
    6.0
  - DeleteSynchronizedHash
```
boolean DeleteSynchronizedHash(String name)
```
    Destroy a synchronized hash
    
    Parameters:
    
    name - String name
    
    Returns:
    
    boolean success (false means no such hash). errno cleared or set if error.
  - AppEvent
```
boolean AppEvent(String name,
                 String guid,
                 String times,
                 FTValList params)
```
    Create an event which triggers a registered function (via GUID or class)
    
    Parameters:
    
    name - name to register event under; be cautious with characters used in event name, { is a bad idea.
    
    guid - to invoke on event fire
    
    times - coded time string for event firing (see XML doc for details)
    
    params - vallist of argument names/values; may be null
    
    Returns:
    
    boolean success/failure. Use GetErrno() to view the error.
  - EmailEvent
```
boolean EmailEvent(String name,
                   String tolist,
                   String times,
                   String filespec)
```
    Create an event which triggers an email
    
    Parameters:
    
    name - name to register event under; be cautious with characters used in event name, { is a bad idea.
    
    tolist - user list to receive email
    
    times - coded time string for event firing (see XML doc for details)
    
    filespec - file to send on event trigger
    
    Returns:
    
    boolean success/failure. Use GetErrno() to view the error.
  - EmailEvent
```
boolean EmailEvent(String name,
                   String tolist,
                   String times,
                   String filespec,
                   String contenttype,
                   String charset,
                   FTValList attachments)
```
    Create an event which triggers an email
    
    Parameters:
    
    name - name to register event under; be cautious with characters used in event name, { is a bad idea.
    
    tolist - user list to receive email
    
    times - coded time string for event firing (see XML doc for details)
    
    filespec - file to send on event trigger
    
    contenttype - The content-type for the message. May be null to default to text/plain
    
    charset - The charset for the message. May be null if body contains only US-ASCII characters or contenttype contains charset.
    
    attachments - Attachments to send with email
    
    Returns:
    
    boolean success/failure. Use GetErrno() to view the error.
  - DestroyEvent
```
boolean DestroyEvent(String name)
```
    Destroy a registered event by name
    
    Parameters:
    
    name - event name
    
    Returns:
    
    boolean success/failure. Use GetErrno() to view the error.
  - EnableEvent
```
boolean EnableEvent(String name)
```
    Enabled a registered event by name
    
    Parameters:
    
    name - event name
    
    Returns:
    
    boolean success/failure. Use GetErrno() to view the error.
  - DisableEvent
```
boolean DisableEvent(String name)
```
    Disabled a registered event by name
    
    Parameters:
    
    name - event name
    
    Returns:
    
    boolean success/failure. Use GetErrno() to view the error.
  - ReadEvent
```
IList ReadEvent(String sEvent,
                String sList)
```
    Attempt to read an event record
    
    Parameters:
    
    sEvent - event name
    
    sList - list name
    
    Returns:
    
    event record list or null
    
    Since:
    
    4.0
  - QueryEvents
```
IList QueryEvents(String sNamePattern,
                  String sType,
                  Boolean bEnabled,
                  String sList)
```
    Attempt to query for a list of matching events
    
    Parameters:
    
    sNamePattern - event name pattern (can contain one % wildcard) or null for all
    
    sType - event type (1 for servlet request or 2 for email) or null for both
    
    bEnabled - Boolean true for enabled events, false for disabled events, or null for both
    
    sList - list name or null for system generated name
    
    Returns:
    
    event record list or null
    
    Since:
    
    4.0
  - SessionExists
```
boolean SessionExists(String id)
```
    Deprecated. this always returns false
    
    See if a session id is valid
    
    Parameters:
    
    id - session id string
    
    Returns:
    
    true if session id is valid, false if not
  - deployJSPFile
```
COM.FutureTense.Interfaces.IJSPObject deployJSPFile(String sPath,
                                                    String sZone,
                                                    StringBuffer sbError)
```
    Deploy a JSP file.
    
    Parameters:
    
    sPath - Path of the JSP file to deploy
    
    sZone - Name of the JSP zone to store the data (defaults to /) - this is a relative path within server doc root.
    
    sbError - For return values; may contain error information.
    
    Returns:
    
    Returns IJSPObject on success, null on error.
  - deployJSPData
```
COM.FutureTense.Interfaces.IJSPObject deployJSPData(String sData,
                                                    String sZone,
                                                    StringBuffer sbError)
```
    Deploy JSP data contained in a buffer.
    
    Parameters:
    
    sData - The JSP data
    
    sZone - Name of the JSP zone to store the data (defaults to /) - this is a relative path within server doc root.
    
    sbError - For return values; may contain error information.
    
    Returns:
    
    Returns IJSPObject on success, null on error.
  - getIServlet
```
IServlet getIServlet()
```
    Deprecated. The IServlet interface is not portable across various containers, and as such its use should be limited.
    
    Return the IServlet functionality
    
    Returns:
    
    an IServlet for the active request
  - ThrowException
```
void ThrowException()
```
    Interface to xml THROWEXCEPTION functionality - this effects the entire thread ie http request
  - ioErrorThrown
```
boolean ioErrorThrown()
```
    Check to see if the http request has registered an io error ie broken pipe
    
    Returns:
    
    true if an IO error has been reported
  - genID
```
String genID(boolean bClusterSafe)
```
    Generate a unique number.
    
    Parameters:
    
    bClusterSafe - true if the number should be cluster safe.
    
    Returns:
    
    Returns the string containing the number, or null on error.
    
    Since:
    
    4.0
  - getURL
```
String getURL(COM.FutureTense.Interfaces.IURLDefinition oIURLDefinition)
```
    Deprecated. Use ICS.getURL(Definition,String) instead. This method will be removed after Content Server 6.1
    
    Method to generate a URL appropriate for the request.
    
    Parameters:
    
    oIURLDefinition - object which defines the URL
    
    Returns:
    
    URL for the request or null on error
    
    Since:
    
    6.0
  - getURL
```
String getURL(Definition definition,
              String assembler)
```
    Method to generate a URI appropriate for the request
    
    Parameters:
    
    definition - Definition for the URI to generate
    
    assembler - name for the assembler to be used to generate the URI, or null to use the default assembler for this installation of Content Server. Most cases will use null for this argument.
    
    Returns:
    
    url for the request, or null on error.
    
    Since:
    
    6.1.1
  - encode
```
String encode(String base,
              Map map,
              boolean bSession)
```
    Method to build an encoded URL string from a set of attributes
    
    Parameters:
    
    base - String base of the URL
    
    map - Map key and value pairs for attributes
    
    bSession - true to include session id
    
    Returns:
    
    String encoded URL
    
    Since:
    
    4.0
  - decode
```
void decode(String sAttributes,
            Map map)
```
    Method to split the attribute portion of a URL string into a set of attributes.
    
    Parameters:
    
    sAttributes - String attribute string of form k1=v1 and k2=v2
    
    map - Map set of key/value pairs from the string
    
    Since:
    
    4.0
  - diskFileName
```
String diskFileName()
```
    Deprecated. Method is disabled since cached pages are stored in the database now.
    
    Return the name of the current page or subpage execution
    
    Returns:
    
    null always
    
    Since:
    
    4.0
  - diskFileName
```
String diskFileName(String pname,
                    FTValList arguments)
```
    Deprecated. Method is disabled since cached pages are stored in the database now.
    
    Return the name of the suppied pagename with arguments as it would be cached on disk
    
    Parameters:
    
    pname - pagename, not null else returns null and sets errno to ftErrors.badparams
    
    arguments - optional name/value pairs for resargs (ie PageCriteria)
    
    Returns:
    
    null always
    
    Since:
    
    4.0
  - diskFileName
```
String diskFileName(String pname,
                    String arguments)
```
    Deprecated. Method is disabled since cached pages are stored in the database now.
    
    Return the name of the suppied pagename with arguments as it would be cached on disk
    
    Parameters:
    
    pname - pagename, not null else returns null and sets errno to ftErrors.badparams
    
    arguments - optional URL components ie p1=v1 and p2=v2
    
    Returns:
    
    null always
    
    Since:
    
    4.0
  - getPageData
```
COM.FutureTense.ContentServer.PageData getPageData(String pagename)
```
    Get the PageData object for the specified pagename
    
    Parameters:
    
    pagename - pagename to retrieve
    
    Returns:
    
    page data object, never null
    
    Throws:
    
    IllegalArgumentException - if pagename is null or does not correspond to a valid pagename.
  - isCacheable
```
boolean isCacheable(String pagename)
```
    Determine if a page is set to cache at this time. Note that a page can disable its own cache at any time using DisableCache(). This may be called at any time in page evaluation and the answer may not be the same between calls.
    
    Parameters:
    
    pagename - pagename or null to indicate current page.
    
    Returns:
    
    true if the page may be cached, false if the page will never be cached.
    
    Since:
    
    4.0
    
    See Also:
    
    ICS.DisableCache()
  - pageURL
```
String pageURL()
```
    Return the cache key in 'url' form of the current execution instance (page/pagelet). Note that the returned value is not the url used to request the page.
    
    Returns:
    
    cache key in the form of a url string
    
    Since:
    
    4.0
  - pageCriteriaKeys
```
String[] pageCriteriaKeys(String pagename)
```
    Get a String array of page criteria allowable keynames
    
    Parameters:
    
    pagename - name of the page
    
    Returns:
    
    string array of key names
    
    Since:
    
    4.0
  - pageURL
```
String pageURL(String pname,
               FTValList arguments)
```
    Return the cache key in 'url' form of the execution instance (page/pagelet) defined by the input parameters.
    
    Parameters:
    
    pname - the name of the page whose key will be calculated
    
    arguments - the parameters passed into the page, that when filtered by PageCriteria and augmented as required, will result in the cach key.
    
    Returns:
    
    cache key in the form of a url string
    
    Since:
    
    4.0
  - DisableFragmentCache
```
void DisableFragmentCache()
```
    Disable caching on this fragment and all of its parents, but not any of its children.
    
    Since:
    
    4.0
    
    See Also:
    
    ICS.DisableCache()
  - StartBatchContext
```
Object StartBatchContext()
```
    Fetch Batch context object to queue CatalogManager and TreeManager commands
    
    Returns:
    
    Object batch context object
    
    Since:
    
    4.0
  - CommitBatchedCommands
```
boolean CommitBatchedCommands(Object oBatchContext)
```
    Commit CatalogManager and TreeManager commands queued to the batch context
    
    Parameters:
    
    oBatchContext - Object batch context object
    
    Returns:
    
    boolean
    
    Since:
    
    4.0
  - RollbackBatchedCommands
```
boolean RollbackBatchedCommands(Object oBatchContext)
```
    Abort CatalogManager and TreeManager commands queued to the batch context
    
    Parameters:
    
    oBatchContext - Object batch context object
    
    Returns:
    
    boolean
    
    Since:
    
    4.0
  - rsCacheDebug
```
boolean rsCacheDebug()
```
    Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.RESULT_SET_CACHE_DEBUG
    
    Result Set Cache debug flag
    
    Returns:
    
    true if set
    
    Since:
    
    4.0
  - pgCacheDebug
```
boolean pgCacheDebug()
```
    Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.PAGE_CACHE_DEBUG
    
    Page Cache debug flag
    
    Returns:
    
    true if set
    
    Since:
    
    4.0
  - pastramiDebug
```
boolean pastramiDebug()
```
    Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.GENERIC_DEBUG
    
    Pastrami debug flag
    
    Returns:
    
    true if set
    
    Since:
    
    6.0
  - xmlDebug
```
boolean xmlDebug()
```
    Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.XML_DEBUG
    
    XML debug flag
    
    Returns:
    
    true if set
    
    Since:
    
    4.0
  - syncDebug
```
boolean syncDebug()
```
    Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.SYNC_DEBUG
    
    Sync debug flag
    
    Returns:
    
    true if set
    
    Since:
    
    4.0
  - eventDebug
```
boolean eventDebug()
```
    Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.EVENT_DEBUG
    
    Event debug flag
    
    Returns:
    
    true if set
    
    Since:
    
    4.0
  - systemDebug
```
boolean systemDebug()
```
    Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.GENERIC_DEBUG
    
    System (main) debug flag corresponds to ft.debug
    
    Returns:
    
    true if set
    
    Since:
    
    4.0
  - dbDebug
```
boolean dbDebug()
```
    Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.DB_DEBUG
    
    Database debug flag
    
    Returns:
    
    true if set
    
    Since:
    
    4.0
  - sessionDebug
```
boolean sessionDebug()
```
    Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.SESSION_DEBUG
    
    Session debug flag
    
    Returns:
    
    true if set
    
    Since:
    
    4.0
  - timeDebug
```
boolean timeDebug()
```
    Deprecated. Use Apache's commons-logging module instead. The logger name that is used in place of this debug flag is identified by the string value of ftMessage.TIME_DEBUG
    
    Time debug flag
    
    Returns:
    
    true if set
    
    Since:
    
    4.0
  - systemSession
```
boolean systemSession()
```
    Are sessions enabled for the current pagelet?
    
    Returns:
    
    true if set
    
    Since:
    
    4.0
  - BlobServer
```
boolean BlobServer(FTValList args,
                   OutputStream os)
```
    Invoke the BlobServer to retrieve a blob into an output stream
    
    Parameters:
    
    args - Map of blobserver arguments
    
    os - OutputStream to capture bytes
    
    Returns:
    
    Returns true or false if manager call worked. Use GetErrno() to check return codes from the call.
    
    Since:
    
    5.0
  - BlobServer
```
boolean BlobServer(FTValList args,
                   COM.FutureTense.Interfaces.IMIMENotifier im,
                   OutputStream os)
```
    Invoke the BlobServer to retrieve a blob into an output stream internal
    
    Parameters:
    
    args - Map of blobserver arguments
    
    im - IMIMENotifier call back to set header information
    
    os - OutputStream to capture bytes
    
    Returns:
    
    Returns true or false if manager call worked. Use GetErrno() to check return codes from the call.
    
    Since:
    
    5.0
  - getLocaleString
```
String getLocaleString(String sName,
                       String sLocale)
```
    Method to get a locale specific string
    
    Parameters:
    
    sName - name of the string
    
    sLocale - locale of the string (i.e., EN_US)
    
    Returns:
    
    locale specific string
    
    Since:
    
    5.0
  - getPastramiEngine
```
COM.FutureTense.Interfaces.PastramiEngine getPastramiEngine()
```
    Method to return a PastramiEngine object based on the value of the propety cs.PastramiEngine or the override class name passed in
    
    Returns:
    
    PastramiEngine object or null if disabled
    
    Since:
    
    6.0
  - getSatellite
```
COM.FutureTense.Cache.Satellite getSatellite(String id)
```
    Method to get read-only information about a Satellite server.
    
    Parameters:
    
    id - String satellite engine id as defined in the SystemSatelites table
    
    Returns:
    
    Satellite object or null if id is invalid
    
    Since:
    
    6.0
  - getAttribute
```
Object getAttribute(String sName)
```
    Method to get an attribute value from the request
    
    Parameters:
    
    sName - name of the attribute
    
    Returns:
    
    attribute value or null
    
    Since:
    
    6.0
  - getAttributeNames
```
Enumeration getAttributeNames()
```
    Method to get an enumeration of all the request attribute names
    
    Returns:
    
    enumeration of attribute names
    
    Since:
    
    6.0
  - removeAttribute
```
void removeAttribute(String sName)
```
    Method to remove an attribute from the request
    
    Parameters:
    
    sName - name of the attribute
    
    Since:
    
    6.0
  - setAttribute
```
void setAttribute(String sName,
                  Object oValue)
```
    Method to set an attribute for the request
    
    Parameters:
    
    sName - name of the attribute
    
    oValue - value to set
    
    Since:
    
    6.0
  - close
```
void close()
```
    Method to close and release any resources associated with this object
    
    Since:
    
    6.0
  - getNamespace
```
String getNamespace()
```
    The value returned by this method should be prefixed or appended to elements, such as JavaScript variables or function names, to ensure they are unique in the context of the generated page.
    
    Returns:
    
    the namespace
    
    Since:
    
    6.0
  - getUserPrincipal
```
Principal getUserPrincipal()
```
    Returns a java.security.Principal object containing the name of the current authenticated user. If the user has not been authenticated, the method returns null
    
    Returns:
    
    a java.security.Principal containing the name of the user making this request; null if the user has not been authenticated
    
    Since:
    
    6.0
  - getIProperties
```
COM.FutureTense.Interfaces.IProperties getIProperties()
```
    Return an IProperties object that provides access to the properties that are currently loaded into the CS context.
    
    Returns:
    
    IProperties
    
    Since:
    
    6.0

Interface ICS

Field Summary

Method Summary

Field Detail

HTTPVERSION10

HTTPVERSION11

conSrvGuid_id

catManGuid_id

treeManGuid_id

blobSrvGuid_id

evalSrvGuid_id

cacheSrvGuid_id

SQLExpAND

SQLExpOR

SQLExpIN

NoSuchCatalog

SystemCatalog

ContentCatalog

ForeignCatalog

TreeCatalog

ObjectCatalog

TempCatalog

TempTreeCatalog

TRACKING_UNKNOWN

TRACKING_NOTTRACKED

TRACKING_NOTLOCKED

TRACKING_LOCKEDBYOTHER

TRACKING_LOCKEDBYUSER

TRACKING_NOACCESS

Method Detail

PushVars

PopVars

SetVar

SetObj

GetObj

PopObj

PushObj

GetVar

GetBin

GetCounter

SetCounter

RemoveCounter

GetVars

SetVar

RemoveVar

SetSSVar

GetSSVar

GetSSVars

SetSSVar

RemoveSSVar

SessionID

IsSystemSecure

SetVar

GetCgi

GetProperty

GetProperty

IsElement

getElementArgumentValue

GetCatalogType

IsTracked

IsTrackedNewFormat

getTrackingStatus

FlushCatalog

GetErrno

getComplexError

setComplexError

SetErrno

ClearErrno

ResolveVariables

ResolveVariables

SelectTo

CallSQL

getSQL

CallSQL

SQL

SQL

SQL

literal

SQLExp

SQLExp