模块组标准文档-周忠君

Service（包）

UserService（类）

//假设是按数据库标准组的attendance表

1.List listPresentStudent(BigInteger seminarId,BigInteger classId)

  • 方法简介:根据讨论课id及班级id，讨论课所在的班级出勤学生信息

  • 参数: 1.BigInteger seminarId (讨论课的id) ，2.BigInteger classId（班级的id）

  • 返回值: List 处于出勤状态的所有学生信息

  • 调用的dao方法:

    1.UserDao.listPresentStudent(BigInteger seminarId,BigInteger classId)

2.List listLateStudent(BigInteger seminarId,BigInteger classId)

  • 方法简介:根据讨论课id及班级id，讨论课所在的班级迟到学生信息

  • 参数: 1.BigInteger seminarId (讨论课的id) ，2.BigInteger classId（班级的id）

  • 返回值: List 处于迟到状态的所有学生信息

  • 调用的dao方法:

    1.UserDao.listLateStudent(BigInteger seminarId,BigInteger classId)

3.List listAbsenceStudent(BigInteger seminarId,BigInteger classId)

  • 方法简介:根据讨论课id及班级id，讨论课所在的班级的缺勤学生信息

  • 参数: 1.BigInteger seminarId (讨论课的id) ，2.BigInteger classId（班级的id）

  • 返回值: List 处于缺勤状态的所有学生信息

  • 调用的dao方法:

    1.UserDao.listAbsenceStudent(BigInteger seminarId,BigInteger classId)

SeminarService（类）

1.Seminar getMySeminarBySeminarId(BigInteger seminarId，User userId)

  • 方法简介:获得与当前学生相关的讨论课的信息（此学生是否是队长，当前讨论课是否处于签到状态，当前讨论课是否可以选题，当前讨论课的组队方式）

  • 参数: 1.BigInteger seminarId (讨论课的id) 2.User userId （用户的id）

  • 返回值: SeminarBo 讨论课的信息

  • 调用的dao方法:

    1.SeminarDao.getSeminarBySeminarId(BigInteger seminarId)

    2.GroupDao. getGroupById(BigInteger seminarId，BigInteger userId)

2.Seminar getSeminarDetailBySeminarId(BigInteger seminarId,BigInteger userId)

  • 方法简介:根据讨论课Id获得该讨论课的详细信息（包括讨论课信息，上课地点，教师信息）

  • 参数: 1.BigInteger seminarId (讨论课的id)

  • 返回值: SeminarBo 讨论课的详细信息

  • 调用的dao方法:

    1.SeminarDao.getSeminarBySeminarId(BigInteger seminarId)

    2.UserDao.getUserByUserId(BigInteger userId)

    3.ClassDao.getClassById(BigInteger seminarId,BigInteger userId)

TopicService（类）

1.Topic getTopicByTopicId(BigInteger topicId)

  • 方法简介:根据话题Id获得改话题的信息

  • 参数: 1.BigInteger topicId (话题的id)

  • 返回值: TopicBo 该话题的信息

  • 调用的dao方法:

    1.TopicDao.getTopicByTopicId(BigInteger topicId)

2.boolean updateTopicBySeminarId(BigInteger topicId，Topic topic)

  • 方法简介:根据话题的id和topic 的信息修改对应的topic 的内容

  • 参数: 1.BigInteger topicId（话题的id） 2.Topic topic（要修改的话题的内容）

  • 返回值: 是否成功修改话题

  • 调用的dao方法:

    1.TopicDao.updateTopicBySeminarId(BigInteger topicId，Topic topic)

3.boolean deleteTopicBySeminarId(BigInteger topicId)

  • 方法简介:根据讨论课Id删除该话题

  • 参数: 1.BigInteger topicId (话题的id)

  • 返回值: 是否成功删除话题

  • 调用的dao方法:

    1.TopicDao.deleteTopicByTopicId(BigInteger topicId)

4.List listTopicBySeminarId(BigInteger seminarId)

  • 方法简介:根据讨论课Id获得该讨论课的所有topic的信息

  • 参数: 1.BigInteger seminarId (讨论课的id)

  • 返回值: List 该讨论课的所有topic的信息

  • 调用的dao方法:

    1.TopicDao.listTopicBySeminarId(BigInteger seminarId)

5.BigInteger insertTopicBySeminarId(BigInteger seminarId,Topic topic)

  • 方法简介:根据讨论课Id和topic的资料，创建一门属于该讨论课的话题

  • 参数: 1.BigInteger seminarId (讨论课的id) ， 2.Topic topic(话题的所有信息)

  • 返回值: 讨论课的id

  • 调用的dao方法:

    1.TopicDao.insertTopicBySeminarId(BigInteger seminarId,Topic topic)

GroupService（类）

1.List listGroupBySeminarId(BigInteger seminarId)

  • 方法简介:根据讨论课Id获得属于该讨论课的所有小组的信息

  • 参数: 1.BigInteger seminarId (讨论课的id)

  • 返回值: List 所有group的信息

  • 调用的dao方法:

    1.GroupDao.listGroupBySeminarId(BigInteger seminarId)

2.List listGroupByTopicId(BigInteger topicId)

  • 方法简介:根据话题Id获得选择该话题的所有小组的信息

  • 参数: 1.BigInteger topicId(话题的id)

  • 返回值: List 所有选择该话题的所有group的信息

  • 调用的dao方法:

    1.GroupDao. listGroupByTopicId(BigInteger topicId)

3.Group getSeminarGroupById(BigInteger seminarId,BigInteger userId)

  • 方法简介: 根据讨论课Id及用户id，获得该用户所在的讨论课的小组的信息

  • 参数: 1.BigInteger seminarId (讨论课的id) ，2.BigInteger userId（用户的id）

  • 返回值: Group Group的相关信息

  • 调用的dao方法:

    1..GroupDao. getGroupById(BigInteger seminarId，BigInteger userId)

ClassService（类）

1.Class getCallGroupStatusById(BigInteger seminarId,BigInteger classId)

  • 方法简介:根据讨论课Id及班级id，获得该班级的签到、分组状态

  • 参数: 1.BigInteger seminarId (讨论课的id) ，2.BigInteger classId（班级的id）

  • 返回值: Class Class的相关信息

  • 调用的dao方法:

    1.SeminarDao.getSeminarBySeminarId(BigInteger seminarId)

    2.ClassDao.getClassByClassId(BigInteger classId)

AttendanceService（类）

//经纬度海拔不知道要不要存一个类

1.Boolean updateAttendanceById(integer seminarId,integer classId,integer userId,经纬度海拔类 )javascript:void(null)

  • 方法简介:根据讨论课id及班级id，学生id，进行签到

  • 参数: 1.BigInteger seminarId (讨论课的id) ，2.BigInteger classId（班级的id），3.BigInteger userId (讨论课的id) ，4.经纬度海拔类

  • 返回值: 是否成功修改考勤状态

  • 调用的dao方法:
    1.AttendanceDao.updateAttendanceById(integer seminarId,integer classId,integer userId,经纬度海拔类)

Dao(包)

UserDao（类）

1.User getUserByUserId(BigInteger userId)

  • 方法简介:根据用户id返回用户信息

  • 参数: 1.BigInteger userId(用户的id)

  • 返回值: UserDo 班级的信息

  • 调用的Mapper方法:UserMapper.selectUserByUserId(BigInteger userId)

2.List listPresentStudent(BigInteger seminarId,BigInteger classId)

  • 方法简介:根据seminar id和class id去查找所有的迟到学生的信息

  • 参数: 1.BigInteger seminarId（讨论课id）,2.BigInteger classId（班级id）

  • 返回值: List 所有学生的信息

  • 调用的Mapper方法:UserMapper.selectPresentStudent(BigInteger seminarId,BigInteger classId)

3.List listAbsenceStudent(BigInteger seminarId,BigInteger classId)

  • 方法简介:根据seminar id和class id去查找所有的缺勤学生的信息

  • 参数: 1.BigInteger seminarId（讨论课id）,2.BigInteger classId（班级id）

  • 返回值: List 所有学生的信息

  • 调用的Mapper方法:UserMapper.selectAbsenceStudent(BigInteger seminarId,BigInteger classId)

4.List listLateStudent(BigInteger seminarId,BigInteger classId)

  • 方法简介:根据seminar id和class id去查找所有的迟到学生的信息

  • 参数: 1.BigInteger seminarId（讨论课id）,2.BigInteger classId（班级id）

  • 返回值: List 所有学生的信息

  • 调用的Mapper方法:UserMapper.selectLateStudent(BigInteger seminarId,BigInteger classId)

SeminarDao（类）

1.Seminar getSeminarBySeminarId(BigInteger seminarId)

  • 方法简介:获得与当前讨论课id的讨论课的信息

  • 参数: 1.BigInteger seminarId (讨论课的id)

  • 返回值: SeminarDo 讨论课的信息

  • 调用的Mapper方法:SeminarMapper.selectSeminarBySeminarId(BigInteger seminarId)

ClassDao（类）

1.Class getClassByClassId(BigInteger classId)

  • 方法简介:根据班级的id来获得班级信息

  • 参数: 1.BigInteger classId (班级的id)

  • 返回值: ClassDo 班级的信息

  • 调用的Mapper方法:ClassMapper.sellectClassByClassId(BigInteger classId)

2.Class getClassById(BigInteger seminarId,BigInteger userId)

  • 方法简介:根据用户id和讨论课的id来获得当前用户所上讨论课的所在班级信息

  • 参数: 1.BigInteger seminarId (讨论课的id) 2.BigInteger userId(用户的id)

  • 返回值: ClassDo 班级的信息

  • 调用的Mapper方法:ClassMapper.sellectClassById(BigInteger seminarId,BigInteger userId)

TopicDao（类）

1.Topic getTopicByTopicId(BigInteger topicId)

  • 方法简介:根据话题Id获得改话题的信息

  • 参数: 1.BigInteger topicId (话题的id)

  • 返回值: TopicDo 该话题的信息

  • 调用的Mapper方法:TopicMapper.selectTopicByTopicId(BigInteger topicId)

2.boolean updateTopicBySeminarId(BigInteger topicId，Topic topic)

  • 方法简介:根据话题的id和topic 的信息修改对应的topic 的内容

  • 参数: 1.BigInteger topicId（话题的id） 2.Topic topic（要修改的话题的内容）

  • 返回值: 是否成功修改话题

  • 调用的Mapper方法:TopicMapper.updateTopicBySeminarId(BigInteger topicId，Topic topic)

3.boolean deleteTopicBySeminarId(BigInteger topicId)

  • 方法简介:根据讨论课Id删除该话题

  • 参数: 1.BigInteger topicId (话题的id)

  • 返回值: 是否成功删除话题

  • 调用的Mapper方法:TopicMapper.deleteTopicByTopicId(BigInteger topicId)

4.List listTopicBySeminarId(BigInteger seminarId)

  • 方法简介:根据讨论课的id来获得当前讨论课的所有话题信息

  • 参数: 1.BigInteger seminarId (讨论课的id)

  • 返回值: .List 所有讨论课的信息

  • 调用的Mapper方法:TopicMapper.selectTopicBySeminarId(BigInteger seminarId)

5.BigInteger insertTopicBySeminarId(BigInteger seminarId,Topic topic)

  • 方法简介:根据讨论课的id来获得当前讨论课的所有话题信息

  • 参数: 1.BigInteger seminarId (讨论课的id) 2.Topic topic(要创建的话题信息)

  • 返回值: 话题的id

  • 调用的Mapper方法:TopicMapper.insertTopicBySeminarId(BigInteger seminarId,Topic topic)

GroupDao（类）

1.Group getGroupById(BigInteger seminarId，BigInteger userId)

  • 方法简介:获得与当前学生在当前讨论课的小组信息（队长是谁，是否选题等）

  • 参数: 1.BigInteger seminarId (讨论课的id) 2.BigInteger userId（学生的id）

  • 返回值: GroupDo 小组的信息

  • 调用的Mapper方法:Groupper.selectGroupById(BigInteger seminarId，BigInteger userId)

2.List listGroupByTopicId(BigInteger topicId)

  • 方法简介:根据话题Id获得选择该话题的所有小组的信息

  • 参数: 1.BigInteger topicId(话题的id)

  • 返回值: List 所有选择该话题的所有group的信息

  • 调用的Mapper方法:GroupMapper. selectGroupByTopicId(BigInteger topicId)

3.Group List listGroupBySeminarId(BigInteger seminarId)

  • 方法简介:获得与当前讨论课的所有小组信息

  • 参数: 1.BigInteger seminarId (讨论课的id)

  • 返回值: List 所有小组的信息

  • 调用的Mapper方法:GroupMapper.selectGroupBySeminarId(BigInteger seminarId)

AttendanceDao（类）

1.Boolean updateAttendanceById(integer seminarId,integer classId,integer userId,经纬度海拔类)

  • 方法简介:根据讨论课id， 班级id，学生id，在考勤表修改学生的考勤状态为出勤

  • 参数: 1.BigInteger seminarId (讨论课的id) 2.BigInteger classId（班级的id） 3.BigInteger userId（学生的id）4.经纬度海拔类

  • 返回值: 是否成功修改考勤状态

  • 调用的Mapper方法:AttendanceMapper.updateAttendanceById(integer seminarId,integer classId,integer userId,经纬度海拔类)

Mapper(包)

UserMapper（类）

1.User selectUserByUserId(BigInteger userId)

  • 方法简介:根据用户id返回用户信息

  • 参数: 1.BigInteger userId(用户的id)

  • 返回值: UserDo 班级的信息

2.List selectPresentStudent(BigInteger seminarId,BigInteger classId)

  • 方法简介:根据seminar id和class id去查找所有的迟到学生的信息

  • 参数: 1.BigInteger seminarId（讨论课id）,2.BigInteger classId（班级id）

  • 返回值: List 所有学生的信息

3.List selectAbsenceStudent(BigInteger seminarId,BigInteger classId)

  • 方法简介:根据seminar id和class id去查找所有的缺勤学生的信息

  • 参数: 1.BigInteger seminarId（讨论课id）,2.BigInteger classId（班级id）

  • 返回值: List 所有学生的信息

4.List selectLateStudent(BigInteger seminarId,BigInteger classId)

  • 方法简介:根据seminar id和class id去查找所有的迟到学生的信息

  • 参数: 1.BigInteger seminarId（讨论课id）,2.BigInteger classId（班级id）

  • 返回值: List 所有学生的信息

SeminarMapper（类）

1.Seminar selectSeminarBySeminarId(BigInteger seminarId)

  • 方法简介:获得与当前讨论课id的讨论课的信息

  • 参数: 1.BigInteger seminarId (讨论课的id)

  • 返回值: SeminarDo 讨论课的信息

ClassMapper（类）

1.Class selectClassByClassId(BigInteger classId)

  • 方法简介:根据班级的id来获得班级信息

  • 参数: 1.BigInteger classId (班级的id)

  • 返回值: ClassDo 班级的信息

2.Class selectClassById(BigInteger seminarId,BigInteger userId)

  • 方法简介:根据用户id和讨论课的id来获得当前用户所上讨论课的所在班级信息

  • 参数: 1.BigInteger seminarId (讨论课的id) 2.BigInteger userId(用户的id)

  • 返回值: ClassDo 班级的信息

TopicMapper（类）

1.Topic selectTopicByTopicId(BigInteger topicId)

  • 方法简介:根据话题Id获得改话题的信息

  • 参数: 1.BigInteger topicId (话题的id)

  • 返回值: TopicDo 该话题的信息

2.boolean updateTopicBySeminarId(BigInteger topicId，Topic topic)

  • 方法简介:根据话题的id和topic 的信息修改对应的topic 的内容

  • 参数: 1.BigInteger topicId（话题的id） 2.Topic topic（要修改的话题的内容）

  • 返回值: 是否成功修改话题

3.boolean deleteTopicBySeminarId(BigInteger topicId)

  • 方法简介:根据讨论课Id删除该话题

  • 参数: 1.BigInteger topicId (话题的id)

  • 返回值: 是否成功删除话题

4.List selectTopicBySeminarId(BigInteger seminarId)

  • 方法简介:根据讨论课的id来获得当前讨论课的所有话题信息

  • 参数: 1.BigInteger seminarId (讨论课的id)

  • 返回值: .List 所有讨论课的信息

5.BigInteger insertTopicBySeminarId(BigInteger seminarId,Topic topic)

  • 方法简介:根据讨论课的id来获得当前讨论课的所有话题信息

  • 参数: 1.BigInteger seminarId (讨论课的id) 2.Topic topic(要创建的话题信息)

  • 返回值: 话题的id

GroupMapper（类）

1.Group selectGroupById(BigInteger seminarId，BigInteger userId)

  • 方法简介:获得与当前学生在当前讨论课的小组信息（队长是谁，是否选题等）

  • 参数: 1.BigInteger seminarId (讨论课的id) 2.BigInteger userId（学生的id）

  • 返回值: GroupDo 小组的信息

2.List selectGroupByTopicId(BigInteger topicId)

  • 方法简介:根据话题Id获得选择该话题的所有小组的信息

  • 参数: 1.BigInteger topicId(话题的id)

  • 返回值: List 所有选择该话题的所有group的信息

3.Group List selectGroupBySeminarId(BigInteger seminarId)

  • 方法简介:获得与当前讨论课的所有小组信息

  • 参数: 1.BigInteger seminarId (讨论课的id)

  • 返回值: List 所有小组的信息

AttendanceMapper（类）

1.Boolean updateAttendanceById(integer seminarId,integer classId,integer userId,经纬度海拔类)

  • 方法简介:根据讨论课id， 班级id，学生id，在考勤表修改学生的考勤状态为出勤

  • 参数: 1.BigInteger seminarId (讨论课的id) 2.BigInteger classId（班级的id） 3.BigInteger userId（学生的id）4.经纬度海拔类

  • 返回值: 是否成功修改考勤状态

©著作权归作者所有,转载或内容合作请联系作者
平台声明：文章内容（如有图片或视频亦包括在内）由作者上传并发布，文章内容仅代表作者本人观点，简书系信息发布平台，仅提供信息存储服务。

推荐阅读更多精彩内容

  • 模块组标准文档-周忠君
    #Service（包） ###UserService（类） //假设是按数据库标准组的attendance表 1....
    DreamF_95d0阅读 385评论 0赞 0
  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,993评论 19赞 139
  • Kafka史上最详细原理总结
    姓名：周小蓬 16019110037 转载自：http://blog.csdn.net/YChenFeng/art...
    aeytifiw阅读 34,754评论 13赞 425
  • 无标题文章
    # 一度蜜v3.0协议 --- # 交互协议 [TOC] ## 协议说明 ### 请求参数 下表列出了v3.0版协...
    c5e350bc5b40阅读 672评论 0赞 0
  • 网易云Web SDK 开发手册
    点击查看原文 Web SDK 开发手册 SDK 概述 网易云信 SDK 为 Web 应用提供一个完善的 IM 系统...
    layjoy阅读 13,951评论 0赞 15