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, int port, String name, String user, String password)

getBBjEnterpriseNamespace(String host, int port, String name, String user, String password, long timeout)

getBBjEnterpriseNamespace(String host, int port, String name, String user, String password, long timeout, String keystore, String keypass)

getBBjEnterpriseNamespace(String host, int 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()
HashMap<String,Long> getFunctionDebugCounts()
HashMap<String,Long> getFunctionDebugNanoTimes()
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.00, 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()
BBjWebManager getWebManager()
BBjThinClient getThinClient()
int isInMDI()
boolean isSAMAvailable()
void killSession(BBjSessionInfo SessionInfo, String username, String password)
void lcheckin(int license)
int lcheckout(String feature, String version)
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 resetFunctionDebug()
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

Note:

In BBj 22.03 and higher, BBjWebManager is an alias for BBjBuiManager.

Constants

0

FALSE

1

TRUE

Example

rem 'Obtain the instance of the BBjAPI object

declare BBjAPI BBjAPI!
BBjAPI! = BBjAPI()

See Also

BBj Object Variables

BBj Object Creation and Assignment

BBj Object Error Handling

BBj Object Operators

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.