BBjAPI

Description

The BBjAPI object is the entry point for creating and using BBj Objects.

Creation

Obtain a BBjAPI object through the following method:

Return Value	Method
BBjAPI	BBjAPI()

Methods of BBjAPI

Return Value	Method
byte[]	asBytes(string sourcestring)
void	changePassword(string userName, string oldPassword, string newPassword)
void	clearCustomEventCallback(string eventName)
void	clearLastBBjException()
void	clearLastJavaException()
ClientObject	cloneAsClientObject(Objectserver Obj)
Object	cloneAsServerObject(ClientObject clientObj)
void	copy(BBjVector source, array target) copy(array source, array target)
BBjRecordSet	createFileRecordSet(string filename, string modes, string template)
BBjRecordSet	createMemoryRecordSet(string stringTemplate)
BBjRecordSet	createSQLRecordSet(string connect, string modes, string select) createSQLRecordSet(string connect, string modes, string select, boolean updateable) createSQLRecordSet(string connect, string modes, string select, boolean scrollSensitive)
void	createTimer(Object key, number seconds, CustomObject obj, string methodName) createTimer(Object key, number seconds, string label)
BBjAdmin	getAdmin(string user, string password)
BBjAppletProxy	getAppletProxy()
BBjEnterpriseNamespace	getBBjEnterpriseNamespace(string host, string port, string name, string user, string password) getBBjEnterpriseNamespace(string host, string port, string name, string user, string password, long timeout) getBBjEnterpriseNamespace(string host, string port, string name, string user, string password, long timeout, string keystore, string keypass) getBBjEnterpriseNamespace(string host, string port, string name, string user, string password, string keystore, string keypass)
BBjForm	getBBjPDFForm(string filename) getBBjPDFForm(string filename, boolean useImage) getBBjPDFForm(string filename, PrintRequestAttributeSet attributes) getBBjPDFForm(string filename, PrintRequestAttributeSet attributes, boolean useImage)
BBjPrinter	getBBjPrinter(AttributeSet attributes, int client) getBBjPrinter(int client) getBBjPrinter(String name, int client)
BBjBuiManager	getBuiManager()
BBjConfig	getConfig()
BBjSessionInfo	getCurrentSessionInfo()
string	getDefaultPrinterName(int client)
BBjErrorInfo	getErrorInfo()
BBjEventData	getEventData()
BBjNamespace	getExistingNamespace(String name)
BBjVector	getExistingNamespaceNames()
BBjFileSystem	getFileSystem()
BBjNamespace	getGlobalNamespace()
BBjNamespace	getGroupNamespace()
BBjInterpreterServer	getInterpreterServer()
BBjCollapsableJDBCConnection	getJDBCConnection(String url) getJDBCConnection(string url, string mode) getJDBCConnection(string url , java.util.Properties props) getJDBCConnection(string url , string user, string password)
java.lang.Throwable	getLastBBjException()
BBjEvent	getLastEvent()
java.lang.Throwable	getLastException()- deprecated in BBj 12.0, use getLastBBjException() or getLastJavaException()
java.lang.Throwable	getLastJavaException()
BBjLDAPConnection	getLDAPConnection() getLDAPConnection(string host, int port, string bindDN, string password)
BBjMDI	getMDI()
Counter	getMetricCounter(String name)
Gauge	getMetricGauge(String name)
BBjNamespace	getNamespace(string prefixName, string baseName, int createIfNeeded)
BBjNamespace	getNewNamespace(string prefixName)
BBjObjectTable	getObjectTable()
BBjVector	getOpenChannels()
BBjVector	getOpenSQLChannels()
BBjProgramInfo	getProgramInfo() getProgramInfo(string filename)
BBjServletData	getServletData()
BBjVector	getSessionInfos()
string	getStbl(string key)
BBjSysGui	getSysGui()
BBjThinClient	getThinClient()
int	isInMDI()
void	killSession(BBjSessionInfo SessionInfo, string username, string password)
string	listProcessStatus()
BBjVector	lookupPrinters(AttributeSet attributes, int client)
BBjColor	makeColor(int colorNum) makeColor(int red, int green, int blue) makeColor(int red, int green, int blue, int alpha) makeColor(string colorName)
BBjTemplatedString	makeTemplatedString()
BBjVector	makeVector()
int	newBBjSession(BBjCommandLineObject cmdLineObj)
int	newSynchBBjSession(BBjCommandLineObject cmdLineObj)
BBjNumber	number! = num("1") print number!.booleanValue()
BBjSysGui	openSysGui(string alias)
void	postCustomEvent(string eventName, Object payload)
void	postPriorityCustomEvent(string eventName, Object payload)
Counter	registerMetricCounter(String name, String help, String... labels)
Gauge	registerMetricGauge(String name, String help, String... labels)
void	removeAllTimers()
void	removeDatabaseGlobal(string databaseName, string propertyName)
void	removeNamespace(string name)
void	removeTimer(Object key)
void	setCustomEventCallback(string eventName, CustomObject customObj, string methodName) setCustomEventCallback(string eventName, string subRoutineName)
string	setStbl(string key, string value)
void	unregisterMetricCounter(String name)
void	unregisterMetricGauge(String name)

Remarks

None.

Constants

0	FALSE
1	TRUE

Example

REM Obtain the instance of the BBjAPI object

declare BBjAPI BBjAPI!
BBjAPI! = BBjAPI()