bbj40.gif 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

void

changePassword(string userName, string oldPassword, string newPassword)

void

clearCustomEventCallback(string eventName)

ClientObject

cloneAsClientObject(Object serverObj)

Object

cloneAsServerObject(ClientObject clientObj)

BBjRecordSet

createFileRecordSet(string filename, string modes, string template)

BBjRecordSet

createMemoryRecordSet(string stringTemplate)

BBjRecordSet

createSQLRecordSet(string connect, string modes, string select)

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

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)

BBjProgramInfo

getProgramInfo(string filename)

BBjConfig

getConfig()

string

getDatabaseGlobal(string databaseName, string propertyName)

BBjNamespace

getExistingNamespace(string name)

BBjFileSystem

getFileSystem()

BBjNamespace

getGlobalNamespace()

BBjNamespace

getGroupNamespace()

BBjInterpreterServer

getInterpreterServer()

BBjCollapsableJDBCConnection

getJDBCConnection()

java.lang.Throwable

getLastException()

BBjEvent

getLastEvent()

BBjMDI

getMDI()

BBjNamespace

getNamespace(string prefixName, string baseName, int createIfNeeded)

BBjNamespace

getNewNamespace(string prefixName)

BBjObjectTable

getObjectTable()

BBjProgramInfo

getProgramInfo()

BBjVector

getForm(int dialog)

BBjVector

getSessionInfos()

BBjSysGui

getSysGui()

BBjThinClient

getThinClient()

int

isInMDI()

void

killSession(BBjSessionInfo SessionInfo, string username, string password)

string

listProcessStatus()

BBjVector

lookupPrinters(AttributeSet attributes)

BBjVector

makeVector()

BBjColor

makeColor(int colorNum)

BBjColor

makeColor(int red, int green, int blue)

BBjColor

makeColor(string colorName)

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

removeDatabaseGlobal(string databaseName, string propertyName)

void

setCustomEventCallback(string eventName, string subRoutineName)

void

setCustomEventCallback(string eventName, CustomObject customObj, string methodName)

void

setDatabaseGlobal(string databaseName, string propertyName, string value)

void

removeAllTimers()

void

removeTimer(Object key)

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.