--- loncom/enrollment/localenroll.pm	2010/07/12 23:55:07	1.40
+++ loncom/enrollment/localenroll.pm	2013/03/01 04:49:04	1.44
@@ -1,6 +1,6 @@
 # functions to glue school database system into Lon-CAPA for 
 # automated enrollment
-# $Id: localenroll.pm,v 1.40 2010/07/12 23:55:07 raeburn Exp $
+# $Id: localenroll.pm,v 1.44 2013/03/01 04:49:04 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -123,6 +123,8 @@ sub run() {
   <middlename>D</middlename>
   <startdate></startdate>
   <studentID>A12345678</studentID>
+  <credits></credits>
+  <inststatus></inststatus>
  </student>
  
  with the following at the top of the file
@@ -147,6 +149,17 @@ sub run() {
  If dates are to included in the XML file, they should be in the format
  YYYY:MM:DD:HH:MM:SS (: separators required).
 
+ The <credits> tag need only be used if the credits earned by the students will 
+ be different from the default for the course. The course default is set when the
+ course is created and can be modifed by a Domain Coordinator via "View or
+ modify a course  or community" on the DC's Main Menu screen.
+
+ A value for <inststatus> should be the institutional status used for students,
+ and should be one of the types defined in inst_usertypes(). If no status
+ types are defined for the domain this tag can be omitted. If Autoupdate.pl
+ is enabled in your domain, updates to the institutional status set here
+ will be updated by Autoupdate.pl, should changes occur.
+
  If there were 10 students in fs03nop590001, 5 students in fs03nop59o601, 
  8 students in fs03nop590602, and 2 students in fs03ost580002,
  then $$reply{'43551dedcd43febmsul1'} = 25
@@ -233,7 +246,7 @@ sub get_sections {
  The course section or crosslisted course will only be added to the list of
  affiliates if 'ok' is returned.
 
- new_course takes three arguments -
+ new_course takes three required arguments -
  (a) the institutional courseID (in the MSU case this is a concatenation of 
  semester code, department code, course number, and section number
  e.g., fs03nop590001).
@@ -242,10 +255,14 @@ sub get_sections {
  username:domain
  (c) the LON-CAPA domain that contains the course
 
+ new_course also takes a fourth (optional) argument -
+ (d) the course co-owners, as a comma-separated list of username:domain for
+ any co-owners. 
+
 =cut
 
 sub new_course  {
-    my ($course_id,$owner,$dom) = @_;
+    my ($course_id,$owner,$dom,$coowners) = @_;
     my $outcome = 'ok';
     return $outcome;
 }
@@ -297,8 +314,14 @@ validate_instcode takes three arguments
  (c) an optional institutional username for the course owner.
 
 An array is returned containing (a) the result of the check for a valid 
-instcode, and (b) an (optional) course description.   
+instcode, (b) an (optional) course description, and (c) the default credits
+earned by students when completing this course. If no institutional credits
+value is available, the default credits for the course can be set via the
+course request form, or via XML in a batch file, of via the web form used
+by the Domain Coordinator to create new courses one at a time.
+
 A valid instcode is confirmed by returning 'valid'.
+
 If no course description is available, '' should be set as
 the value of the second item in the returned array.
 
@@ -308,7 +331,8 @@ sub validate_instcode {
     my ($dom,$instcode,$owner) = @_;
     my $outcome = '';
     my $description = '';
-    return ($outcome,$description);
+    my $credits = '';
+    return ($outcome,$description,$credits);
 }
 
 =pod
@@ -374,7 +398,7 @@ lonnet -> lond -> localenroll.pm) The do
 a table where columns are course type (official, unofficial or community) 
 and rows are institutional affiliations (e.g., Faculty, Staff, Student etc.).
 
-crsreq_checks() takes three arguments: $dom, $reqtyes, $validations.
+crsreq_checks() takes three arguments: $dom, $reqtypes, $validations.
 $dom - the domain for which validation options are needed.
 $reqtypes - ref to an ARRAY of course types (i.e., official, unofficial and community.
 $validations - ref to a hash of a hash which will determine whether "validate"
@@ -731,6 +755,9 @@ sub instcode_defaults {
                 keys will be unique IDs (student or faculty/staff ID)
                 values will be either: scalar (username) or an array 
                 if a single ID matches multiple usernames.
+ (d) $lc_users - reference to hash containing LON-CAPA usernames in 
+                 in domain $dom, as keys. Needed if institutional
+                 data source only allows query by username.
  returns 1 parameter - 'ok' if no processing error, or other value 
                        if an error occurred.
  side effects - populates the $instusers and $instids refs to hashes.
@@ -741,7 +768,7 @@ sub instcode_defaults {
 =cut
 
 sub allusers_info {
-    my ($dom,$instusers,$instids) = @_;
+    my ($dom,$instusers,$instids,$lc_users) = @_;
     my $outcome = 'ok';
     return $outcome; 
 }