loncom/enrollment/localenroll.pm - diff

Return to localenroll.pm CVS log

Up to [LON-CAPA] / loncom / enrollment

Diff for /loncom/enrollment/localenroll.pm between versions 1.11 and 1.16

-version 1.11, 2006/02/07 04:54:17
+version 1.16, 2006/08/29 05:58:06
  Line 204  sub get_sections {
  # (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).
- # (b) the course owner. This is the LON-CAPA username of the course coordinator
+ # (b) the course owner. This is the LON-CAPA username and domain of the course
- # assigned to the course when it is first created.
+ # coordinator assigned to the course when it is first created, in the form
+ # username:domain
  # (c) the LON-CAPA domain that contains the course
  #
  #################################
- Line 256  sub validate_courseID {
+ Line 257  sub validate_courseID {
  # (a) $authparam - the value of <autharg> from the classlist.xml files,
  # or if this blank, the default autharg, set by the domain coordinator when
  # creating the course with loncreatecourse.pm
- # (b) $username - the username of the new user
  # (b) $dom - the domain of the new user.
+ # (c) $username - the username of the new user (currently not actually used)
  #
  # Four values are returned:
  # (a) the value of $authparam - which might have been changed
- Line 286  sub validate_courseID {
+ Line 287  sub validate_courseID {
  ###############################
  sub create_password {
-     my ($authparam,$username,$dom) = @_;
+     my ($authparam,$dom,$username) = @_;
      my $authchk = 'ok';
      my $newpasswd = '';
      my $create_passwd = 0;
- Line 335  sub instcode_format () {
+ Line 336  sub instcode_format () {
      return $outcome;
  }
+ ###############################
+ # sub institutional_photos
+ #
+ # Called when automated enrollment manager is used to update student photos.
+ #
+ # Incoming data: six arguments
+ # (a) $dom (domain)
+ # (b) $crs (LONCAPA course number)
+ # (c) $affiliates: a reference to a hash with the keys set to the
+ # institutional course IDs for the course.
+ # (d) $result: a reference to a hash which will return usernames
+ #     of students (& separated) in following categories (the keys):
+ #     new, update, missing, same, deleted, noid, nouser. The list
+ #     includes those students for whom the result of the modification
+ #     process was either addition of a new photo. update of an
+ #     existing photo, photo was found to be missing from institution's
+ #     data store, photo used is same as before, or photo was
+ #     deleted from storage on LON-CAPA server housing student's
+ #     information, no student ID was available.
+ # (e) $action: the type of action needed. (e.g., update, delete);
+ # (f) $students: a reference to a hash with the keys set to student
+ # usernames and domains in the form username:domain, and values set
+ # to the studentID, if action is required for specific students.
+ #
+ # returns 1 parameter: 'ok' if no processing errors.
+ # other course or student specific values can be stored as values
+ # in the appropriate referenced hashes.
+ ###############################
+ sub institutional_photos {
+     my ($dom,$crs,$affiliates,$result,$action,$students) = @_;
+     my $outcome = 'ok';
+     return $outcome;
+ }
+ ###############################
+ # sub photo_permission
+ #
+ # Incoming data: three arguments
+ # (a) $dom (domain)
+ # (b) $perm_reqd: a reference to a a scalar that is either 'yes'
+ # if a course owner must indicate acceptance of conditions of use,
+ # 'no' otherwise.
+ # (c) $conditions: the text of the conditions of use.
+ #
+ # returns 1 parameter: 'ok' if no processing errors.
+ # $$perm_reqd is set to 'yes' or 'no'
+ # $$agreement is set to conditions of use - plain text string
+ #             which will be displayed in a textarea in a web form.
+ ###############################
+ sub photo_permission {
+    my ($dom,$perm_reqd,$conditions) = @_;
+    $$perm_reqd = 'no';
+    $$conditions = '';
+    my $outcome = 'ok';
+    return $outcome;
+ }
+ ###############################
+ # sub manager_photo_update
+ #
+ # Incoming data: one argument
+ # (a) $dom (domain)
+ #
+ # returns 2 parameters: update (0 or 1), and comment.
+ # Called by automated enrollment manager, to determine
+ # whether "Update Student photos" button will be available,
+ # and if so, the message (plain text string) that will be displayed
+ # with the button.
+ ###############################
+ sub manager_photo_update {
+     my ($dom) = @_;
+     my $update = 0;
+     my $comment = '';
+     return ($update,$comment);
+ }
+ ###############################
+ # sub check_section
+ #
+ # Incoming data: three arguments (+ fourth optional argument)
+ # (a) $class - institutional class id (coursecode concatanated with section)
+ # (b) $owner - course owner (2.2 and later username:domain; pre-2.2 username)
+ # (c) $dom 0 domain of course
+ # (d) $dbh - optional database handle
+ #
+ # returns 1 parameter - $sectioncheck ('ok' or other value).
+ # Verifies that course owner has access to classlist for specific class
+ # according to institution's SIS. 'ok' if access available
+ ###############################
+ sub check_section {
+     my ($class,$owner,$dom,$dbh) = @_;
+     my $sectioncheck = 'ok';
+     return $sectioncheck;
+ }
+ ###############################
+ # sub AUTOLOAD
+ #
+ # Incoming data: none
+ # Returns ''
+ #
+ # Prevents errors when undefined subroutines are called in this package
+ # Will allow new routines added in the future to be called from lond etc.
+ # without the need for customized versions of local*.pm packages to be
+ # modified to include the new subroutines immediately.
+ #
+ # See "Programming Perl" 3rd ed. pp 296-298.
+ ###############################
+ sub AUTOLOAD {
+     our $AUTOLOAD;
+     return '';
+ }
 ;

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>

Removed from v.1.11
changed lines
	Added in v.1.16