TokOpen Object Model

The TokOpen API relies on an understanding of the TokOpen Object Model, this is used to define all entities within TokOpen. Your application should always start by creating a TOKOPEN_VIEW object, from which all other objects can be referenced.

The sumbols used in this guide are :-

 An Object Class
 A Collection of Objects
 An Enunerated list of Values
 A method of an Object
 A property of an Object
 An event generated by an Object

The major programming objects in the TokOpen applicaiton, and their approximate hierarchy are :-

 TOKOPEN_ENVIRONMENT the Top level container object that defines all others
     TOKOPEN_DRAWERLIST defines all the drawers in the TokOpen database
           TOKOPEN_DRAWER the properties of a drawer
               TOKOPEN_CRITERIALIST a collection of fields in a drawer (or criteria for a search)
                    TOKOPEN_CRITERIA the details of a field
                         TOKOPEN_FIELDS an enumerated list of all fields used, Folder Index etc...
                         TOKOPEN_FIELDTYPE a list of field types, numeric etc...
                         TOKOPEN_CONDITIONS a list of possible search conditions
               TOKOPEN_WORKFLOWS lists all workflow processes for a drawer
                    TOKOPEN_WORKFLOW details a workflow action
                        TOKOPEN_CRITERIALIST defines conditions for a workflow action
               TOKOPEN_ACLLIST defines the access control for a drawer
                    TOKOPEN_ACL defines the permissions of access
                         ACL_TYPE either User or Group
     TOKOPEN_DOCTYPES lists all document types
           TOKOPEN_DOCTYPE details of a document type
               TOKOPEN_DOCCLASS indicates if document type is image, application or folder
     TOKOPEN_USERS lists all users of the system
           TOKOPEN_USER details of a user
     TOKOPEN_GROUPS lists all groups in the sytstem
           TOKOPEN_GROUP details of a group
     TOKOPEN_MEDIALIST
           TOKOPEN_MEDIA
     TOKOPEN_VIEWS
           TOKOPEN_VIEW
                TOKPEN_VIEWTYPE
               TOKOPEN_CRITERIALIST
               TOKOPEN_FIELDLIST
                     TOKOPEN_FIELD
               TOKOPEN_DOCLIST
               TOKOPEN_ENVIRONMENT