Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

< record_status_p > Protocol Reference

#import <record_status_p.h>

Inheritance diagram for < record_status_p >:

controller_t List of all members.

Public Member Functions

(char *) current_field_name
(unsigned) current_field_index
(char *) current_record_name
(char *) current_table_name
(long) current_record_id
(long) current_record_id_master
(void) set_current_record_id::
(record_t *) record_that_record_joins_to
(char *) name_of_record_that_record_joins_to
(char *) scriptcode_before_retrieve
(char *) scriptcode_after_retrieve
(pointerlist_t *) list_of_records_that_join
(record_state_tstatus
(void) set_status:

Detailed Description

protocol that may be passed to communicate(and modify) record status


Member Function Documentation

- (unsigned) current_field_index  
 

method that returns index of current field

Parameters:
none 
Returns:
field index

- (char *) current_field_name  
 

method that returns name of current field

Parameters:
none 
Returns:
field name, US7ASCII

- (long) current_record_id  
 

method that returns value of surrogate key in current record

Parameters:
none 
Returns:
record key value

- (long) current_record_id_master  
 

method that returns value of surrogate key for parent record in parent table of this record.

Parameters:
none 
Returns:
parent-table record key value

- (char *) current_record_name  
 

method that returns name of current record

Parameters:
none 
Returns:
record name, US7ASCII

- (char *) current_table_name  
 

method that returns name of db table of current record. returns NULL if not a dbtable.

Parameters:
none 
Returns:
string containing db table name

- (pointerlist_t *) list_of_records_that_join  
 

method that returns list of records that join this record

Parameters:
none 
Returns:
pointerlist (that is usually non-nil) that may containt 0 objects

- (char *) name_of_record_that_record_joins_to  
 

method that returns name of master-record in tree-like structure of records.

Parameters:
none 
Returns:
name string or NULL

- (record_t *) record_that_record_joins_to  
 

method that returns pointer of master-record in tree-like structure of records. may be used to judge whether this record is in the root of the tree, or somewhere else. this judgement in turn affects at least record id generation

Parameters:
none 
Returns:
pointer to record or nil

- (char *) scriptcode_after_retrieve  
 

method that returns pointer to code that is supposed to be run after record is fetched from db

Parameters:
none 
Returns:
code text or NULL if there is no code

- (char *) scriptcode_before_retrieve  
 

method that returns pointer to code that is supposed to be run before record is fetched from db

Parameters:
none 
Returns:
code text or NULL if there is no code

- (void) set_current_record_id: (long)  aNewRecordId
: (long)  aNewRecordIdMaster
 
 

method that sets value of surrogate key values in current record

Parameters:
aNewRecordId new record key value
aNewRecordIdMaster new parent-table record key value
Returns:
none

- (void) set_status: (record_state_t aStatus  
 

method for setting record status

Parameters:
aStatus is the new status
Returns:
none

- (record_state_t) status  
 

method for getting record status

Parameters:
none 
Returns:
status


The documentation for this protocol was generated from the following file:
Generated on Sun May 15 23:45:24 2005 for kort4 by  doxygen 1.4.2