[LON-CAPA-cvs] cvs: loncom /enrollment localenroll.pm

[raeburn]

raeburn		Fri Nov  9 22:10:49 2007 EDT

  Modified files:              
    /loncom/enrollment	localenroll.pm 
  Log:
  Adding stubs for  &id_rules() and &id_check() to default localenroll.pm for 
  "namespacing" of user IDs.
  -  &id_rules() defines rules for format of official IDs.
  -  &id_check() checks if the proposed ID for a user matches these formats.
  
  
Index: loncom/enrollment/localenroll.pm
diff -u loncom/enrollment/localenroll.pm:1.26 loncom/enrollment/localenroll.pm:1.27
--- loncom/enrollment/localenroll.pm:1.26	Wed Sep 12 15:50:47 2007
+++ loncom/enrollment/localenroll.pm	Fri Nov  9 22:10:49 2007
@@ -1,6 +1,6 @@
 # functions to glue school database system into Lon-CAPA for 
 # automated enrollment
-# $Id: localenroll.pm,v 1.26 2007/09/12 19:50:47 raeburn Exp $
+# $Id: localenroll.pm,v 1.27 2007/11/10 03:10:49 raeburn Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -631,6 +631,33 @@
 }
 
 ###############################
+# sub id_rules
+#
+# Incoming data: three arguments
+# (a) $dom - domain
+# (b) $ruleshash - reference to hash containing rules
+#                  (a hash of a hash)
+#                  keys of top level hash are short names
+#                   (e.g., netid, noncredit)
+#                  for each key, value is a hash
+#                      desc => long name for rule
+#                      rule => description of rule
+#
+# (c) $rulesorder - reference to array containing rule names
+#                   in order to be displayed
+
+#
+#  returns 'ok' if no processing error.
+#
+###############################
+
+sub id_rules {
+    my ($dom,$ruleshash,$rulesorder) = @_;
+    my $outcome;
+    return $outcome;
+}
+
+###############################
 # sub username_check 
 #
 # Incoming data: four arguments
@@ -653,6 +680,28 @@
 }
 
 ###############################
+# sub id_check
+#
+# Incoming data: four arguments
+# (a) $dom - domain (scalar)
+# (b) $id - ID to compare against rules (scalar)
+# (c) $to_check (reference to array of rule names to check)
+# (d) $resultshash (reference to hash of results)
+#                    hash of results for rule checked
+#                   - keys are rule names
+#                   - values are: 1 or 0 (for matched or unmatched)
+#
+# returns 'ok' if no processing error.
+#
+###############################
+
+sub id_check {
+    my ($dom,$id,$to_check,$resultshash) = @_;
+    my $outcome;
+    return $outcome;
+}
+
+###############################
 # sub AUTOLOAD
 #
 # Incoming data: none