class ToDo - jcobban/Genealogy GitHub Wiki

Up: Object-Oriented Access to Database Records

Source Code

This class is derived from Record to implement the logical interface to a record in the ToDo table (tblTD). Each entry in this table contains the description of a pending work item. The table maintains a separate set of work items for each User.

Fields

This record presents the following fields:

field name description synonyms
'idtd' unique numeric key
'todotype' to do type. See constants TD_XXX below 'type'
'idir' identifier of instance of class Person. null if no specific Person.
'idtc' to do document category. See constants TC_XXX below. 'category'
'idtl' identifier of instance of class Location. null if no specific Location.
'todoname' name of work item assigned by User. 'name'
'username' name of the instance of class User that created this work item
'openedsd' opened sorting date (yyyymmdd)
'openedd' opened internal date
'remindersd' reminder sorting date
'reminderd' reminder internal date
'closedd' closed text date
'idar' identifier of instance of Address identifying the Repository from which the documentation is to be obtained. null if no specific Repository.
'status' status, 0 for closed or 1 for open
'priority' priority, 0 = low, 1 = medium, 2 = high
'desc' description text 'notes'
'results' results text
'filingref' filing reference code

Note that this implementation does not use the ToDoLocations table (tblTL). Instead it shares the Locations table (tblLR).

Note that this implementation does not use the ToDoCategories table (tblTC) because it does not support internationalization. Instead the values of field idtc are interpreted by language specific templates.

Constants

This class defines the following constants which indicate the type of work item:

constant description value
TD_TODOITEM Research work item 0
TD_CORRESPONDENCE Correspondence 1
TD_OTHER Other 2

This class defines the following constants which indicate the type of source document which the work item focuses on:

constant description value
TC_NULL no specific document type 1
TC_BIRTH_CERTIFICATE birth certificate 2
TC_CEMETERY cemetery 3
TC_CENSUS census 4
TC_CHURCH_RECORD church record 5
TC_COURT_RECORD court record 6
TC_DEATH_CERTIFICATE death certificate 7
TC_IMMIGRATION immigration record 8
TC_LAND_DEED land deed 9
TC_LAND_PATENT land patent 10
TC_MARRIAGE_CERTIFICATE marriage certificate 11
TC_MILITARY_RECORD military record 12
TC_NATURALIZATION naturalization 13
TC_OBITUARY obituary 14
TC_PROBATE_ESTATE probate estate 15
TC_SHIP_PASSENGER_LIST ship passenger list 16
TC_SS_DEATH_INDEX US Social Security Death Index 17
TC_TAX_RECORDS tax records 18
TC_TOMBSTONE tombstone 19
TC_WILL will 20

Table of Contents

Next: new ToDo($parms)