PATH  WebObjects 4.0 Documentation > SybaseEOAdaptor Reference



SybaseContext

Inherits From:
EOAdaptorContext : NSObject

Inherits From:
com.apple.yellow.sybaseeoadaptor


Class Description

A SybaseContext represents a single transaction scope on the database server to which its adaptor object is connected. Since a Sybase server supports multiple concurrent transaction sessions, the adaptor may have several adaptor contexts. A SybaseContext may in turn have a SybaseChannel, which handles actual access to the data on the server.

The features the SybaseContext class adds to EOAdaptorContext are methods for returning Sybase-specific data structures that describe characteristics of the context.

The SybaseContext can have a delegate, which gives you access to all messages returned from the Sybase client library or from the Sybase Server. See the SybaseContext.Delegate interface specification for a complete description. SybaseContext also provides the following callback methods for use by the SybaseChannel:


Method Types

Setting the login time out interval
loginTimeOutInterval
setLoginTimeOutInterval
Setting the time out interval
setTimeOutInterval
timeOutInterval
Managing the connection
connect
currentChannel
disconnect
isConnected
Setting the max text size default
maxTextSizeDefault
setMaxTextSizeDefault
Setting the current exception
raiseCurrentException
setCurrentException

Class Methods


loginTimeOutInterval

public static int loginTimeOutInterval()

Returns the login time out interval used by SybaseContext.

See also: setLoginTimeOutInterval


setLoginTimeOutInterval

public static void setLoginTimeOutInterval(int seconds)

Sets the login time out interval value SybaseContext uses during the creation of new channels. The default is 0, which means that there is no time out.

See also: loginTimeOutInterval


setTimeOutInterval

public static void setTimeOutInterval(int seconds)

Sets the time out interval valueSybaseContext uses during the creation of new channels. The default is 0, which means that there is no time out.

See also: timeOutInterval


timeOutInterval

public static int timeOutInterval()

Returns the time out interval used by SybaseContext.

See also: setTimeOutInterval


Instance Methods


connect

public void connect()

Opens a connection to the database server. SybaseChannel sends this message to SybaseContext when it (SybaseChannel) is about to open a channel to the server.

See also: disconnect


currentChannel

public SybaseChannel currentChannel()

Returns the SybaseChannel currently associated with the receiving context.


disconnect

public void disconnect()

Closes a connection to the database server. SybaseChannel sends this message to SybaseContext when it (SybaseChannel) has just closed a channel to the server.

See also: connect


isConnected

public boolean isConnected()

Returns YES if the receiver has an open connection to the database, NO otherwise.

See also: connect, disconnect


maxTextSizeDefault

public int maxTextSizeDefault()

Returns the maximum number of bytes to be returned from a Sybase image to text field. The default is set to INT_MAX, as defined for the host machine. This number can be overwritten on a per-channel basis by sending the appropriate SQL to the channel using the evaluateExpression: method.

See also: setMaxTextSizeDefault


raiseCurrentException

public void raiseCurrentException()

If the receiver has an exception, raises it.

See also: setCurrentException


setCurrentException

public void setCurrentException(java.lang.Throwable exception)

Sets to exception the receiver's current exception.

When the SybaseAdaptor encounters an error, it uses the error message to build an NSException and stores the exception in the SybaseContext using this method. The exception can then be reviewed by other components to determine if the error is fatal.

See also: raiseCurrentException


setMaxTextSizeDefault

public void setMaxTextSizeDefault(int textSize)

Sets to textSize the receiver's default textsize. Any channels created after this method has been invoked will use the newly specified textSize.

See also: maxTextSizeDefault





Copyright © 1998, Apple Computer, Inc. All rights reserved.