Open-ILS/src/c-apps/oils_idl.h

   1 #include "opensrf/log.h"
   2 #include "opensrf/utils.h"
   3 #include "opensrf/osrf_hash.h"
   4
   5 osrfHash* oilsIDLInit( char* );
   6 osrfHash* oilsIDL();
   7 osrfHash* oilsIDLFindPath( char*, ... );
   8
   9 /* The oilsIDL hash looks like this:
  10
  11 { aws : {
  12         classname       : "aws",
  13         fieldmapper     : "actor::workstation",
  14         tablename       : "actor.workstation",          optional
  15         sequence        : "actor.workstation_id_seq",   optional
  16         primarykey      : "id",
  17         virtual         : "true",                       optional, "true" | "false"
  18         fields          : {
  19                 isnew : {
  20                         name            : "isnew",
  21                         array_position  : "0",
  22                         virtual         : "true",       "true" | "false"
  23                         primitive       : "number"      optional, JSON primitive (number, string, array,
  24                                                         object, bool)
  25                 },
  26                 ...
  27         },
  28         links           : {
  29                 record : {
  30                         field           : "owning_lib", field above that links to another class
  31                         rel_type        : "has_a",      link type, "has_a" | "has_many" | "might_have"
  32                         class           : "aou",        the foreign class that is linked
  33                         key             : "id",         the foreign class's key that creates the link to "field"
  34                         map             : []            osrfStringArray used by cstore in "has_many" rel_types to
  35                                                         point through a linking class
  36                 },
  37                 ...
  38         },
  39         ...
  40 }
  41
  42 */
  43