BaseCollaboration class

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 80 summarizes the methods of the BaseCollaboration class.

Table 80. BaseCollaboration method summary
Method Description Page
dropFailedEvent() Removes a failed event from a collaboration dropFailedEvent()
dynamicSend() Sends a service request to a consumer of the request which is determined dynamically at run time. dynamicSend()
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()
isCallerInRole() Determine the specific role of a web client. isCallerInRole()
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()
queryFailedEvents() Builds a list of failed events that match the query criteria. queryFailedEvents()
raiseException() Raise a collaboration exception. raiseException()
resubmitFailedEvent() resubmits an event from the saved failed event queue for processing by the collaboration. resubmitFailedEvent()
saveFailedEvent() Saves a failed event to the saved failed event queue. saveFailedEvent()
sendEmail() Send an e-mail message asynchronously. sendEmail()
trace() Generate a trace message. trace()

Copyright IBM Corp. 2004, 2005