Changes between Initial Version and Version 1 of DeveloperGuidelines/SaveSearchAndSubscription


Ignore:
Timestamp:
08/21/11 05:28:46 (10 years ago)
Author:
Pratyush Nigam
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DeveloperGuidelines/SaveSearchAndSubscription

    v1 v1  
     1[[TOC]]
     2= Save Search & Subscription =
     3
     4== Purpose ==
     5
     6The save search and subscription functionality can be used to enable to save the searches he makes and would like to revisit in future or subscribe to them to get updates on a daily/weekly/monthly basis.
     7
     8== Data Model ==
     9
     10
     11=== Data Model ===
     12
     13
     14==== Save Search ====
     15
     16Holds information about the search query and the parameters that are saved by the user. The data model can be found in models/04_pr.py.
     17
     18||'''Field Name'''||'''Purpose'''||'''Datatype/table'''||
     19||  timestamp ||Keeps the track of time of creation and subsequent modifications. ||datetime||
     20|| user_id ||The user id of the user who saved the search. ||FK referenced from auth_user.id (integer)||
     21||subscribed||The subscribed status of the user to a particular saved search.||boolean||
     22||search_vars||The search parameters for the search saved by the user||string (Assumption for the time being)||
     23||person_id||The person_id of the user who saves the search||FK referenced from pr_person||
     24
     25==== Subscription ====
     26
     27Holds information about the subscription details. The data model can be found in models/msg.py.
     28
     29||'''Field Name'''||'''Purpose'''||'''Datatype/table'''||
     30||  timestamp ||Keeps the track of created and modified time. ||datetime||
     31||user_id||The user_id of the user who selects the subscription mode ||FK referenced from auth_user.id (integer)||     
     32||subscribe_mode||Describes the mode(s) of subscription selected ||||
     33||subscription_frequency||The frequency at which the subscription are to be sent.||||
     34||person_id||The person_id of the user who saves the search||FK referenced from pr_person||