The methods documented in this chapter operate on collaboration objects. They are defined on the InterChange Server Express-defined class BaseCollaboration. The BaseCollaboration class is the base class for all collaborations. All created collaborations are subclasses of BaseCollaboration; they all inherit these methods.
Table 58 summarizes the methods of the BaseCollaboration
class.
Method | Description | Page |
---|---|---|
existsConfigProperty() | Test the existence of a collaboration configuration property. | existsConfigProperty() |
getConfigProperty() | Retrieve the value of a collaboration configuration property. | getConfigProperty() |
getConfigPropertyArray() | Retrieve the value of a multi-element collaboration configuration property. | getConfigPropertyArray() |
|
|
|
getDBConnection() | Establish a connection to a database and returns a CwDBConnection object. | getDBConnection() |
getLocale() | Retrieve the locale of the collaboration. | getName() |
getMessage() | Retrieve a message, identified by its message number, from the collaboration message file. | getMessage() |
getName() | Retrieve the name of this collaboration object. | getName() |
implicitDBTransactionBracketing() | Retrieve the transaction programming model that the collaboration object uses for any connection it obtains. | implicitDBTransactionBracketing() |
isTraceEnabled() | Compare the specified trace level with the current trace level of the collaboration. | isTraceEnabled() |
logError(), logInfo(), logWarning() | Send an error, information, or warning message to the log file. | logError(), logInfo(), logWarning() |
raiseException() | Raise a collaboration exception. | raiseException() |
sendEmail() | Send an email message asynchronously. | sendEmail() |
trace() | Generate a trace message. | trace() |