View of /trunk/webwork2/doc/new-DB-API

    1 --------------------------------------------------------------------------------
    2 DB API
    3 --------------------------------------------------------------------------------
    4 
    5 The DB API defines the following methods. These methods are grouped according to which tables they access. A method followed by a list of "=>"-prefixed methods depends on the listed methods.
    6 
    7 password
    8 
    9 	listPasswords()
   10 	addPassword($Password)
   11 	getPassword($userID)
   12 	putPassword($Password)
   13 	deletePassword($userID)
   14 
   15 permission
   16 
   17 	listPermissionLevels()
   18 	addPermissionLevel($PermissionLevel)
   19 	getPermissionLevel($userID)
   20 	putPermissionLevel($PermissionLevel)
   21 	deletePermissionLevel($userID)
   22 
   23 key
   24 
   25 	listKeys()
   26 	addKey($Key)
   27 	getKey($userID)
   28 	putKey($Key)
   29 	deleteKey($userID)
   30 
   31 user
   32 
   33 	listUsers()
   34 	addUser($User)
   35 	getUser($userID)
   36 	putUser($User)
   37 	deleteUser($userID)
   38 		=> deletePassword($userID)
   39 		=> deletePermissionLevel($userID)
   40 		=> deleteKey($userID)
   41 		=> deleteUserSet($userID, *)
   42 
   43 set
   44 
   45 	listGlobalSets()
   46 	addGlobalSet($GlobalSet)
   47 	getGlobalSet($setID)
   48 	putGlobalSet($GlobalSet)
   49 	deleteGlobalSet($setID)
   50 		=> deleteGlobalProblem($setID, *)
   51 		=> deleteUserSet(*, $setID)
   52 
   53 set_user
   54 
   55 	listSetUsers($setID)
   56 	listUserSets($userID)
   57 	addUserSet($UserSet)
   58 	getUserSet($userID, $setID)
   59 	putUserSet($UserSet)
   60 	deleteUserSet($userID, $setID)
   61 		=> deleteUserProblem($userID, $setID, *)
   62 
   63 problem
   64 
   65 	listGlobalProblems($setID)
   66 	addGlobalProblem($GlobalProblem)
   67 	getGlobalProblem($setID, $problemID)
   68 	putGlobalProblem($GlobalProblem)
   69 	deleteGlobalProblem($setID, $problemID)
   70 		=> deleteUserProblem(*, $setID, $problemID)
   71 
   72 problem_user
   73 
   74 	listProblemUsers($setID, $problemID)
   75 	listUserProblems($userID, $setID)
   76 	addUserProblem($UserProblem)
   77 	getUserProblem($userID, $setID, $problemID)
   78 	putUserProblem($UserProblem)
   79 	deleteUserProblem($userID, $setID, $problemID)
   80 
   81 set+set_user
   82 
   83 	getGlobalUserSet($userID, $setID)
   84 		=> getGlobalSet($setID)
   85 		=> getUserSet($userID, $setID)
   86 
   87 problem+problem_user
   88 
   89 	getGlobalUserProblem($userID, $setID, $problemID)
   90 		=> getGlobalProblem($setID, $problemID)
   91 		=> getUserProblem($userID, $setID, $problemID)