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(Object serverObj)

Object

cloneAsServerObject(ClientObject clientObj)

void

copy(BBjVector vector, BBjArray array)

BBjRecordSet

createFileRecordSet(string filename, string modes, string template)

BBjRecordSet

createMemoryRecordSet(string stringTemplate)

BBjRecordSet

createSQLRecordSet(string connect, string modes, string select)

BBjRecordSet

createSQLRecordSet(string connect, string modes, string select, boolean scrollSensitive)

BBjRecordSet

createSQLRecordSet(string connect, string modes, string select, boolean updateable)

void

createTimer(Object key, int seconds, string label)

void

createTimer(Object key, int seconds, CustomObject obj, string methodName)

BBjAdmin

getAdmin(string user, string password)

BBjAppletProxy

getAppletProxy()

BBjEnterpriseNamespace

getBBjEnterpriseNamespace(string host, string port, string name, string user, string password)

BBjEnterpriseNamespace

getBBjEnterpriseNamespace(string host, string port, string name, string user, string password, long timeout)

BBjForm

getBBjPDFForm(string filename)

BBjForm

getBBjPDFForm(string filename, boolean useImage)

BBjForm

getBBjPDFForm(string filename, PrintRequestAttributeSet attributes)

BBjForm

getBBjPDFForm(string filename, PrintRequestAttributeSet attributes, boolean useImage)

BBjPrinter

getBBjPrinter(int client)

BBjPrinter

getBBjPrinter(AttributeSet attributes, int client)

BBjPrinter

getBBjPrinter(string name, int client)

BBjBuiManager

getBuiManager()

BBjProgramInfo

getProgramInfo(string filename)

BBjConfig

getConfig()

BBjSessionInfo

getCurrentSessionInfo()

string

getDefaultPrinterName(int client)

BBjErrorInfo

getErrorInfo()

BBjEventData

getEventData()

BBjNamespace

getExistingNamespace(string name)

BBjVector

getExistingNamespaceNames()

BBjNumber

number! = num("1")
print number!.booleanValue()

BBjFileSystem

getFileSystem()

BBjNamespace

getGlobalNamespace()

BBjNamespace

getGroupNamespace()

BBjInterpreterServer

getInterpreterServer()

BBjCollapsableJDBCConnection

getJDBCConnection()

java.lang.Throwable

getLastBBjException()

java.lang.Throwable

getLastException()- deprecated in BBj 12.0, use getLastBBjException() or  getLastJavaException()

java.lang.Throwable

getLastJavaException()

BBjEvent

getLastEvent()

BBjLDAPConnection

getLDAPConnection()

BBjLDAPConnection

getLDAPConnection(string host, int port, string bindDN, string password)

BBjMDI

getMDI()

BBjNamespace

getNamespace(string prefixName, string baseName, int createIfNeeded)

BBjNamespace

getNewNamespace(string prefixName)

BBjObjectTable

getObjectTable()

BBjVector

getOpenChannels()

BBjVector

getOpenSQLChannels()

BBjProgramInfo

getProgramInfo()

BBjVector

getForm(int dialog)

BBjAPI

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)

BBjVector

makeVector()

BBjColor

makeColor(int colorNum)

BBjColor

makeColor(int red, int green, int blue)

BBjColor

makeColor(string colorName)

BBjColor

makeColor(int red, int green, int blue, int alpha)

BBjTemplatedString

makeTemplatedString()

int

newBBjSession(BBjCommandLineObject cmdLineObj)

int

newSynchBBjSession(BBjCommandLineObject cmdLineObj)

BBjSysGui

openSysGui(string alias)

void

postCustomEvent(string eventName, Object payload)

void

postPriorityCustomEvent(string eventName, Object payload)

void

removeAllTimers()

void

removeDatabaseGlobal(string databaseName, string propertyName)

void

removeNamespace(string name)

void

removeTimer(Object key)

void

setCustomEventCallback(string eventName, string subRoutineName)

void

setCustomEventCallback(string eventName, CustomObject customObj, string methodName)

string

setStbl(string key, string value)

Remarks

None.

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 Assignment

BBj Object Error Handling

BBj Object Operators

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



______________________________________________________________________________________

Copyright BASIS International Ltd. BBj®, Visual PRO/5®, PRO/5®, and BBx® are registered trademarks.