source: TI03-DataExtractor/branches/old_stuff/abstractPWSS/doc/sessionObject_module.txt @ 793

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/TI03-DataExtractor/branches/old_stuff/abstractPWSS/doc/sessionObject_module.txt@793
Revision 793, 1.3 KB checked in by astephen, 13 years ago (diff)

Put all the old code in the old_stuff branch.

Line 
1Help on module sessionObject:
2
3NAME
4    sessionObject
5
6FILE
7    /home/as56/abstractWebService/abstractPWSS/sessionObject.py
8
9DESCRIPTION
10    sessionObject.py
11    =================
12   
13    Session control module for the package.
14   
15    This module holds the SessionObject class that is used
16    to store the contents of user sessions between calls.
17
18CLASSES
19    SessionObject
20   
21    class SessionObject
22     |  An instance of this holds a user session that is stored in a python shelve object.
23     |  It also acts as a dictionary with getitem and setitem funtionality.
24     | 
25     |  Methods defined here:
26     | 
27     |  __init__(self, sessionID=None)
28     |      Generates a unique id for a session if the session object does not already exist.
29     | 
30     |  clearSessionObject(self, session)
31     |      Clears all the user-selected content of a session dictionary.
32     | 
33     |  getSessionID(self)
34     |      Returns the session ID.
35     | 
36     |  loadSessionObject(self)
37     |      [not yet implemented]
38     | 
39     |  readSessionObject(self)
40     |      Reads the current session object from the python shelve object.
41     | 
42     |  saveSessionObject(self)
43     |      [not yet implemented]
44     | 
45     |  writeSessionObject(self, sessionObj)
46     |      Takes session dictionary the current session to a python shelve object.
47
Note: See TracBrowser for help on using the repository browser.