Documentation for crs-dump

Scheduled Course Deleting/Dropping Utilities

This utility allows programs to perform a variety of tasks related to the deleting/dropping of a scheduled course for a student.

Note that you better use the following services from within a Progress TRANSACTION, or Progress will create one for you (!)

There are 2 levels of services:

  1. The higher levels of services are application-level services such as DELETE, DROP or UNDROP, that takes care of "all" the grunt work that needs to be done when a course is dropped or re-scheduled.
  2. The lower levels of services are logical, atomic functions that can be used either by the higher-level services or directly from the application level.
Arguments are:
  1. DEFINE [NEW] Takes care of setting up environment for crs-dump services.
  2. CLEAN_UP Takes care of cleaning up environment for crs-dump services.

Higher-level Services

DELETE (stu-schedule) (Delete OK)
Takes care of deleting all student course related data, such as attendance, behavior and grades. (Delete OK) is FALSE only if a DELETE statement fails.

TRANSFER (stu-schedule) (new-stu-schedule) (Transfer OK)
Takes care of transferring all course related data from to (new-stu-schedule). (Transfer OK) is FALSE if at least one piece of data could not be transferred.

RETRIEVE (stu-schedule) (Retrieve OK)
Takes care of retrieving all course related data that may have been previously transferred to other courses. is not being supported at this time.

EXIST (stu-schedule) (Data Exist)
Takes care of finding out whether there is any course related data in the system for (stu-schedule).

Lower-level Services

SET

INTERACTIVE (Interactive)
Set the utilities for interactive or non-interactive use. The default is interactive use.

ATND
Takes care of performing a task concerning course attendance.

DELETE (stu-schedule) (Delete OK) [Record Locked]
Takes care of deleting all course attendance for given course.
(Delete OK) is FALSE only if a DELETE statement fails.
[Record Locked] Used in non-interactive mode to indicate whether the deletion failed due to a locked record.

MOVE (from-stu-schedule) (to-stu-schedule) (Item To Move) (Undo Item Move) (Undo Course Move) (Move OK) [Force Conflict Choice] [Record Locked] [Need User Input]
Takes care of moving all course attendance from a given course to another course.
[Force Conflict Choice] An input parameter used in non-interactive mode that selects what should be done if there is a conflict.
[Record Locked] An output parameter used in non-interactive mode that indicates whether the MOVE failed because of a locked record.
[Need User Input] An output parameter used in non-interactive mode that indicates that the MOVE couldn't complete without a value for [Force Conflict choice]

EXIST (stu-schedule) (Atnd Exist)
Takes care of finding out whether there is any course attendance data for (stu-schedule).

GRADES
Takes care of performing a task concerning report card data.

DELETE (stu-schedule) (Delete OK) [Record Locked]
Takes care of deleting all report card data for given course.
(Delete OK) is FALSE only if a DELETE statement fails.
[Record Locked] Used in non-interactive mode to indicate whether the deletion failed due to a locked record.

MOVE (from-stu-schedule) (to-stu-schedule) (Item To Move) (Undo Item Move) (Undo Course Move) (Move OK) [Record Locked]
Takes care of moving all report card data from a given course to another course.
[Record Locked] Used in non-interactive mode to indicate whether the move failed due to a locked record.

EXIST (stu-schedule) (Grades Exist)
Takes care of finding out whether there is any report card data for (stu-schedule).

PROGRESS
Takes care of performing a task concerning progress reports data.

DELETE (stu-schedule) (Delete OK)
Takes care of deleting all progress reports data for given course. (Delete OK) is FALSE only if a DELETE statement fails.
[Record Locked] Used in non-interactive mode to indicate whether the deletion failed due to a locked record.

MOVE (from-stu-schedule) (to-stu-schedule) (Item To Move) (Undo Item Move) (Undo Course Move) (Move OK) [Record Locked]
Takes care of moving all progress reports data from a given course to another course.
[Record Locked] Used in non-interactive mode to indicate whether the move failed due to a locked record.

EXIST (stu-schedule) (Progress Exist)
Takes care of finding out whether there is any progress reports data for (stu-schedule).

WARNING
Takes care of displaying a frame on the screen saying that not all course related data could be moved successfully between two courses. Note that it is the responsibility of the application to use this service appropriately. The purpose of this service is simply to provide a uniform UI message.

Last update: October 27, 1995