Documentation for atndutil.i


atndutil is used to access information related to attendance calendars.

DEFINE
Defines the context of atndutil.

CLEAN_UP
Clean up the context of atndutil. This should be called on all exit paths for the program using atndutil.

DOES_COURSE_ATND_COUNT stuCourseAtnd doesItCount
Will return a yes value if this atnd should be counted for REPORTING purpose We use the atnd-date of the passed stu-course-atnd buffer for all checks, even if the date has been altered from the one that was originally entered DO NOT USE THIS ON A NEWLY CREATED stu-course-atnd TO SEE IF ITS OK TO POST ATND. THIS IS ONLY FOR EXTRACTION/REPORTING PURPOSES.

IS_ATND_DAY theDate theGroupBuff isAtndDay
Will return yes if the input date is a membership,atnd-report day in the atnd-calendar. Note: This is called in the process of COURSE_ATND_COUNTS, you do NOT need to call it prior to calling COURSE_ATND_COUNTS. It is to be used for other situations where calling COURSE_ATND_COUNTS or cronutil would be overkill.

ATND_COUNT stu-schedule atnd-class-id startDate endDate theCount
Will return a count of atnd codes in atnd-class for that student for the given date range.

SET CURRENT_BUILDING buildingBuff
Set the building to use for all calls that require a building.

GET STU_ATND_GROUP stu-seq school-year-id [theDate] theGroupBuff
Returns a buffer to the group to use for the student based on the current building. SET CURRENT_BUILDING must be called before this can be called.

GET ATND_GROUP stu-year [theDate] theGroupBuff
Returns a buffer to the group to use for ths student based on the buiding of the stu-year. In order to make further use of the id it is required that the current building be set to the building related to the stu-year.

GET PRIMARY_GROUP theGroupBuff
Return the primary group for the current building. Requires that SET CURRENT_BUILDING has been called.

GET GRADE_GROUP gradeCatalog theGroupBuff
Return the group currently assigned to the passed grade-catalog, or the building default, if the grade is unassigned

GET START_DATE theGroupBuff startDate
Returns the first calendar day for the given group. Requires that SET CURRENT_BUILDING has been called.

GET END_DATE theGroupBuff endDate
Returns the last calendar day for the given group. Requires that SET CURRENT_BUILDING has been called.

GET NEXT_DATE theGroupBuff currentDate nextDate
Given a group and current date returns the next calendar day. Requires that SET CURRENT_BUILDING has been called.

GET PREV_DATE theGroupBuff currentDate prevDate
Given a group and current date returns the previous calendar day. Requires that SET CURRENT_BUILDING has been called.

GET MEMBERSHIP_COUNT theGroupBuff dayCount
Returns the count of membership days for the given group. Requires that SET CURRENT_BUILDING has been called.

GET INTERLEAVE_CODE theGroupBuff targetDate interleave-code-id
Returns the interleave code given a day and group. Requires that SET CURRENT_BUILDING has been called.

GET REPORTING_PERIOD theGroupBuff targetDate reporting-period-num
Returns the reporting period given a day and group. Requires that SET CURRENT_BUILDING has been called.

GET DAY_WEIGHT theGroupBuff targetDate day-weight
Returns the day weight code given a day and group. Requires that SET CURRENT_BUILDING has been called.

GET DAY_IN_YEAR theGroupBuff targetDate day-in-year
Returns the day in year number given a day and group. Requires that SET CURRENT_BUILDING has been called.

IS MEMBERSHIP_DAY theGroupBuff targetDate isMember
Given a day and group detemines whether the day is a membership day. Requires that SET CURRENT_BUILDING has been called.

IS ATND_REPORT_DATE theGroupBuff targetDate isReportDate
Given a day and group detemines whether the day is an attendance report date. Requires that SET CURRENT_BUILDING has been called.

IS ATND_LETTER_DATE theGroupBuff targetDate isAtndLetterDate
Given a day and group detemines whether the day is an attendance letter date. Requires that SET CURRENT_BUILDING has been called.

IS ATND_SCAN_DATE theGroupBuff targetDate isScanDate
Given a day and group detemines whether the day is an attendance scan date. Requires that SET CURRENT_BUILDING has been called.

IS ATND_GRADE_DATE theGroupBuff targetDate isGradeDate
Given a day and group detemines whether the day is an attendance grade date. Requires that SET CURRENT_BUILDING has been called.

IS ATND_TRANS_DATE theGroupBuff targetDate isTransDate
Given a day and group detemines whether the day is an attendance transcript date. Requires that SET CURRENT_BUILDING has been called.