Contents


Preface

Using the Documentation
How This Guide Is Organized
Documentation Conventions
Naming Conventions

Chapter 1 About the Application Server Foundation Class Library

Support for Standard Java APIs
How to Use the iPlanet Application Server API

Additional iPlanet Application Server Features
The Development Environment of iPlanet Application Builder
Deprecated Functionality

Chapter 2 Classes

AppLogic class (deprecated

Package
Variables
Methods
Example

createDataConn( )
createDataConnSet( )
createHierQuery( )
createMailbox( )
createQuery( )
createSession( )
createTrans( )
deleteCache( )
destroySession( )
evalOutput( )
evalTemplate( )
execute( )
getAppEvent( )
getSession( )
getStateTreeRoot( )
isAuthorized( )
isCached( )
loadHierQuery( )
loadQuery( )
log( )
loginSession( )
logoutSession( )
newRequest( )
newRequestAsync( )
removeAllCachedResults( )
removeCachedResult( )
result( )
saveSession( )
setCacheCriteria( )
setSessionVisibility( )
setVariable( )
skipCache( )
streamResult( )
streamResultBinary( )
streamResultHeader( )

BaseUtils clas

Package
Constructor
Methods

convertITemplateDataToResultSet( )
createListRowSet( )
createMethodHash( )
createStringFromBuffer( )
doubleQuote( )
includeJSP( )
initRowSets( )
log( )

DBRowSet clas

Package
Constructors
Methods

bindLoadValue( )
clearParameters( )
getFetchSize( )
getLoadParameter( )
getName( )
getNextRowNumber( )
getQueryFile( )
getQueryName( )
getRowNumber( )
getStaticMethodCache( )
getString( )
init( )
initMetaInfo( )
isEqualToExpression( )
isEqualToValue( )
isExecuted( )
isInitialized( )
isLastFetchableRecord( )
setExecuted( )
setInitialized( )
setName( )
setQueryFile( )
setQueryName( )
setRequest( )
setResponse( )

DefaultHttpSession clas

Package
Constructor
Methods
Related Topics

getHttpSession( )
getString( )
setHttpSession( )

DefaultHttpSession2 clas

Package
Constructor
Methods
Related Topics

getHttpSession2( )
invalidate( )
setHttpSession2( )

DefaultHttpSession2 clas

Package
Constructor
Methods
Related Topics

getHttpSession2( )
invalidate( )
setHttpSession2( )

GUID class (deprecated

Package
Methods
Extends
Example

GUID( )
isNull( )
reset( )

GX class (deprecated

Package
Methods

CreateBuffer( )
CreateBufferFromString( )
CreateStreamBuffer( )
CreateTemplateDataBasic( )
CreateTemplateMapBasic( )
CreateValList( )
ProcessOutput( )
Release( )
WaitForOrder( )

GXContext clas

Examples
Package
Methods
Related Topics

CreateMailbox( )
DestroySession( )
GetAppEventMgr( )
GetObject( )
GetSession( )
GetSessionCount( )
GetStateTreeRoot( )
Log( )
NewRequest( )
NewRequestAsync( )

GXVAL class (deprecated

Package
Example

MemRowSet clas

Package
Constructor
Methods

addListItem( )
addRow( )
addValue( )
getListSelection( )
getTemplateData( )
setListSelection( )
setTemplateData( )

iAS6.0RowSet clas

Package
Constructors
Methods
Related Topics

iASString clas

Package
Constructors
Methods

equals( )
makeSubstring( )
setValue( )

iASStringBuffer clas

Package
Constructors
Methods

append( )
charArray( )
charAt( )
ensureCapacity( )
equals( )
getChars( )
indexOf( )
insert( )
length( )
moveChars( )
removeCharAt( )
replace( )
setCharAt( )
setLength( )
setStringValue( )
tabOrSpaceAt( )
toString( )
trimToSize( )
truncateToLength( )

Session2 class (deprecated

Package
Related Topics

SqlUtil clas

Package
Variables
Constructor
Methods
Examples
Related Topics

loadQuery( )

TemplateDataBasic class (deprecated

Package
Methods
Implements
Example 1
Example 2
Related Topics

groupAppend( )
rowAppend( )
TemplateDataBasic( )

TemplateMapBasic class (deprecated

Package
Methods
Implements
Example
Related Topics

getString( )
put( )
putString( )

Util class (deprecated

Package
Methods

dateToDate( )
dateToTime( )
dateToTimeStamp( )
toString( )

Chapter 3 Interfaces

HttpServletRequest2 Interfac

Package
Methods
Related Topics

convertITemplateDataToResultSet( )
dispatchAction( )
formActionHandlerExists( )
getAppLogic( )
getDefaultTemplate( )
getErrorCodes( )
getErrorMsgs( )
getErrorVars( )
getHttpSessionBean( )
getServletErrorHandler( )
setDefaultTemplate( )
setServletErrorHandler( )
validate( )

HttpSession2 Interfac

Package
Methods

getBytes( )
getInt( )
getString( )
isAuthorized( )
loginSession( )
logoutSession( )
putBytes( )
putInt( )
putString( )

IAppEvent Interface (deprecated

Package
Methods
Example
Related Topics

deleteEvent( )
disableEvent( )
enableEvent( )
enumEvents( )
queryEvent( )
registerEvent( )
setEvent( )

IAppEventMgr Interfac

Attributes and Actions
Features of Application Event Support
Accessing and Creating Application Events
Registering Events
Package
Methods
Related Topics

createEvent( )
deleteEvent( )
disableEvent( )
enableEvent( )
enumEvents( )
getEvent( )
registerEvent( )
triggerEvent( )

IAppEventObj Interfac

Package
Methods
Related Topics

addAction( )
deleteActions( )
enumActions( )
getAttributes( )
getName( )
setAttributes( )

IBuffer Interface (deprecated

Package
Methods

alloc( )
getAddress( )
getSize( )
setData( )

ICallableStmt Interface (deprecated

Package
Methods
Related Topics

close( )
execute( )
executeMultipleRS( )
getMoreResults( )
getParams( )
getResultSet( )
setParams( )

ICallerContext Interfac

Package
Methods
Examples
Related Topics

IColumn Interface (deprecated

Package
Methods
Example 1
Example 2
Related Topics

getName( )
getNullsAllowed( )
getPrecision( )
getScale( )
getSize( )
getTable( )
getType( )

IContext Interfac

Package
Examples
Related Topics

IDataConn Interface (deprecated

Package
Methods
Related Topics

closeConn( )
createTrigger( )
disableTrigger( )
dropTrigger( )
enableTrigger( )
executeQuery( )
getConnInfo( )
getConnProps( )
getDriver( )
getTable( )
getTables( )
prepareCall( )
prepareQuery( )
setConnProps( )

IDataConnSet Interface (deprecated

Package
Methods
Related Topics

addConn( )

IEnumObject Interfac

Package
Methods
Related Topics

enumCount( )
enumNext( )
enumReset( )

IError Interface (deprecated

Package
Methods

getErrorCode( )
getErrorCodeNum( )
getErrorMessage( )
getErrorFacility( )

IHierQuery Interface (deprecated

Package
Methods
Example 1
Example 2
Related Topics

addQuery( )
delQuery( )
execute( )

IHierResultSet Interface (deprecated

Package
Methods
Example
Related Topics

count( )
getColumn( )
getColumnByOrd( )
getResultSet( )
getRowNumber( )
getValueDateString( )
getValueDouble( )
getValueInt( )
getValueString( )
moveNext( )
moveTo( )

IListRowSet Interfac

Package
Methods
Related Topics

addListItem( )
setListSelection( )

ILock Interfac

Package
Methods

changeMode( )
lock( )
unlock( )

IMailbox Interfac

Package
Methods
Related Topics

close( )
open( )
retrieve( )
retrieveCount( )
retrieveReset( )
send( )

IObject Interface (deprecated

Package

IOrder Interface (deprecated

Package
Methods
Related Topics

getState( )

IPreparedQuery Interface (deprecated

Package
Methods
Example
Related Topics

execute( )
setParams( )

IQuery Interface (deprecated

Package
Methods
Example 1
Example 2
Related Topics

getFields( )
getGroupBy( )
getHaving( )
getOrderBy( )
getSQL( )
getTables( )
getWhere( )
setFields( )
setGroupBy( )
setHaving( )
setOrderBy( )
setSQL( )
setTables( )
setWhere( )

IResultSet Interface (deprecated

Package
Methods
Example
Related Topics

close( )
enumColumnReset( )
enumColumns( )
fetchNext( )
getColumn( )
getColumnByOrd( )
getColumnOrdinal( )
getNumColumns( )
getOrder( )
getRowNumber( )
getStatus( )
getValueBinary( )
getValueBinaryPiece( )
getValueDateString( )
getValueDouble( )
getValueInt( )
getValueSize( )
getValueString( )
getValueText( )
getValueTextPiece( )
moveTo( )
rowCount( )
wasNull( )

IRowSet2 Interfac

Package
Methods
Related Topics

getName( )
init( )
initMetaInfo( )
setName( )
setRequest( )
setResponse( )

ISequence Interface (deprecated

Package
Methods
Related Topics

drop( )
getCurrent( )
getNext( )

ISequenceMgr Interface (deprecated

Package
Methods
Related Topics

createSequence( )
getSequence( )

IServerContext Interfac

Package
Methods
Related Topics

createIdentityByString( )
getCallerContext( )
getContext( )

IServletErrorHandler Interfac

Package
Methods

handleInputValueError( )
handleSessionVariableError( )
streamError( )

ISession2 Interface (deprecated

Package
Methods

getSessionApp( )
getSessionData( )
getSessionFlags( )
getSessionID( )
getSessionTimeout( )
saveSession( )
setSessionData( )

ISessionIDGen Interface (deprecated

Package
Related Topics

IState2 Interfac

Package
Methods

createStateChild( )
deleteStateChild( )
getStateChild( )
getStateChildCount( )
getStateContents( )
getStateFlags( )
getStateName( )
getStateTimeout( )
saveState( )
setStateContents( )

IStreamBuffer Interface (deprecated

Package
Method

getStreamData( )

ITable Interface (deprecated

Package
Methods
Example

addRow( )
allocRow( )
deleteRow( )
enumColumnReset( )
enumColumns( )
getColumn( )
getColumnByOrd( )
getColumnOrdinal( )
getDataConn( )
getName( )
getNumColumns( )
setValueBinary( )
setValueBinaryPiece( )
setValueDateString( )
setValueDouble( )
setValueInt( )
setValueString( )
setValueText( )
setValueTextPiece( )
updateRow( )

ITemplateData Interface (deprecated

Package
Methods
Example
Related Topics

getValue( )
isEmpty( )
moveNext( )
setHint( )

ITemplateMap Interface (deprecated

Package
Method
Related Topics

get( )

ITile Interface (deprecated

Package
Methods
Example
Related Topics

getTileChild( )
getTileValue( )
moveTileNextRecord( )
moveTileToRecord( )

ITrans Interface (deprecated

Package
Methods
Example
Related Topics

begin( )
commit( )
rollback( )

IValList Interface (deprecated

Package
Methods
Related Topics

count( )
getNextKey( )
getVal( )
getValBLOB( )
getValBLOBSize( )
getValByRef( )
getValInt( )
getValString( )
removeVal( )
resetPosition( )
setVal( )
setValBLOB( )
setValByRef( )
setValInt( )
setValString( )

Appendix A Return Codes Index