public

Documentation

Index

• func Get(ctx *gin.Context, DB db.Database, sub *controllers.Subject)
• func GetCourses(ctx *gin.Context, DB db.Database, institute *controllers.Institute)
• func GetInstitutes(ctx *gin.Context, DB db.Database)
• func GetOfferingComments(ctx *gin.Context, DB db.Database, off *controllers.Offering)
• func GetOfferingsWithStats(ctx *gin.Context, DB db.Database, sub *controllers.Subject)
• func GetProfessors(ctx *gin.Context, DB db.Database, institute *controllers.Institute)
• func GetRelations(ctx *gin.Context, DB db.Database, sub *controllers.Subject)
• func GetSiblingSubjects(ctx *gin.Context, DB db.Database, sub *controllers.Subject)
• func GetStats(ctx *gin.Context, DB db.Database)
• func ListSubjectsByCourse(ctx *gin.Context, DB db.Database, controller *controllers.Course)
• func SearchSubjects(ctx *gin.Context, DB db.Database, controller *controllers.InstituteCourse)

Functions

func Get

func Get(ctx *gin.Context, DB db.Database, sub *controllers.Subject)

Get gets a subject by its identifier: subject code, course code and course specialization code

func GetCourses

func GetCourses(ctx *gin.Context, DB db.Database, institute *controllers.Institute)

GetCourses gets all course codes from a given institute the database

func GetInstitutes

func GetInstitutes(ctx *gin.Context, DB db.Database)

GetInstitutes gets all institutes from the database

func GetOfferingComments

func GetOfferingComments(ctx *gin.Context, DB db.Database, off *controllers.Offering)

GetOfferingComments retrieves the comments made so far for a given offering

func GetOfferingsWithStats

func GetOfferingsWithStats(ctx *gin.Context, DB db.Database, sub *controllers.Subject)

GetOfferingsWithStats retrieves a list of offerings for a given subject, along with the comment stats associated with them

It is a closure for the GET /api/restricted/offerings endpoint

func GetProfessors

func GetProfessors(ctx *gin.Context, DB db.Database, institute *controllers.Institute)

GetProfessors gets all course codes from a given institute the database

func GetRelations

func GetRelations(ctx *gin.Context, DB db.Database, sub *controllers.Subject)

GetRelations gets the subject's graph: their direct predecessors and successors

func GetSiblingSubjects

func GetSiblingSubjects(ctx *gin.Context, DB db.Database, sub *controllers.Subject)

GetSiblingSubjects gets the subject's siblings: Subjects with same institute, course, specialization and semester

func GetStats

func GetStats(ctx *gin.Context, DB db.Database)

GetStats fetches some statistics from the database

func ListSubjectsByCourse

func ListSubjectsByCourse(ctx *gin.Context, DB db.Database, controller *controllers.Course)

ListSubjectsByCourse gets all subjects from a given course in the database

It differs from SearchSubjects because it does not take an institute parameter

func SearchSubjects

func SearchSubjects(ctx *gin.Context, DB db.Database, controller *controllers.InstituteCourse)

SearchSubjects gets all subjects from a given course in the database

This differs from SubjectsByCourseIdentifier because it uses the institute to find the course