Copyright ©1995 by NeXT Computer, Inc.  All Rights Reserved.





Defined Types




DBExceptions

DECLARED IN dbkit/exceptions.h

SYNOPSIS    typedef enum _DBAccessErrors {
DB_UnimplementedException = DB_ERROR_BASE,
DB_CoercionException,
DB_FormatException,
DB_CursorException,
DB_CommitException
} DBExceptions;

DESCRIPTION Exceptions raised during a database access.



DBFailureCode

DECLARED IN dbkit/enums.h

SYNOPSIS     typedef enum {
DB_ReasonUnknown,
DB_RecordBusy,
DB_RecordStreamNotReady,
DB_RecordHasChanged,
DB_RecordLimitReached,
DB_NoRecordKey,
DB_RecordKeyNotUnique,
DB_NoAdaptor,
DB_AdaptorError,
DB_TransactionError
} DBFailureCode;

DESCRIPTION Error codes returned by an adaptor.



DBFailureResponse

DECLARED IN dbkit/enums.h

SYNOPSIS    typedef enum {
DB_NotHandled,
DB_Abort,
DB_Continue
} DBFailureResponse;

DESCRIPTION Possible returns from methods that respond to a failure notification.



DBImageStyle

DECLARED IN dbkit/DBImageView.h

SYNOPSIS    typedef enum {
DB_ImageNoFrame,
DB_ImagePhoto,
DB_ImageGrayBezel,
DB_ImageGroove
} DBImageStyle;

DESCRIPTION Style of frame to surround an image.



DBRecordListRetrieveMode

DECLARED IN dbkit/enums.h

SYNOPSIS    typedef enum _DBRecordListMode {
DB_SynchronousStrategy,
DB_BackgroundStrategy,
DB_BackgroundNoBlockingStrategy,
} DBRecordListRetrieveMode;

DESCRIPTION Access strategy used by a DBRecordList.



DBRecordRetrieveStatus

DECLARED IN dbkit/enums.h

SYNOPSIS    typedef enum _DBRecordRetrievalStatus {
DB_NotReady,
DB_Ready,
DB_FetchLimitReached,
DB_FetchInProgress,
DB_FetchCompleted
} DBRecordRetrieveStatus;

DESCRIPTION Status of a DBRecordStream or a DBRecordList.



DBRetrieveOrder

DECLARED IN dbkit/enums.h

SYNOPSIS    typedef enum {
DB_NoOrder,
DB_AscendingOrder,
DB_DescendingOrder
} DBRetrieveOrder;

DESCRIPTION Order in which retrieved records are sorted.



DBSelectionMode

DECLARED IN dbkit/DBTableView.h

SYNOPSIS    typedef enum {
DB_RADIOMODE,
DB_LISTMODE,
DB_NOSELECT
} DBSelectionMode

DESCRIPTION Modes in which the user may select rows or columns in a DBTableView.

DB_RADIOMODE Selecting a row or column deselects those previously selected.
DB_LISTMODE Selecting a previously unselected row or column adds it to the selection already made; selecting a previously selected row or column deselects.
DB_NOSELECT No selection is permitted.




Symbolic Constants




Error Code Base Value

DECLARED IN dbkit/exceptions.h

SYNOPSIS    DB_ERROR_BASE

DESCRIPTION Constant added to Database Kit error codes.



Format Types

DECLARED IN dbkit/customType.h

SYNOPSIS    Name Value
DBFormat_EPS "EPS"
DBFormat_RTF "RTF"
DBFormat_TIFF "TIFF"

DESCRIPTION Type of the source image to be displayed or transferred.



No Index Indicator

DECLARED IN dbkit/enums.h

SYNOPSIS    DB_NoIndex

DESCRIPTION No selected position in an indexed array (such as DBTableView).



Null Values

DECLARED IN dbkit/DBValue.h

SYNOPSIS    Name Value
DB_NullDouble (NAN)
DB_NullFloat (NAN)
DB_NullInt ((int)0x7ffffffe)

DESCRIPTION Null returns of appropriate type.



Record Limit Default

DECLARED IN dbkit/DBFetchGroup.h

SYNOPSIS    DB_DEFAULT_RECORD_LIMIT 1000

DESCRIPTION Maximum number of records that a DBFetchGroup will fetch unless explicitly set by the DBRecordList method setRecordLimit:.