模块组标准文档-周忠君

#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方法:

2.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,经纬度海拔类  )

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

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

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

*调用的dao方法:

#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方法:

1.TopicMapper.selectTopicByTopicId(BigInteger topicId)

2.boolean updateTopicBySeminarId(BigInteger topicId，Topic topic)

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

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

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

*调用的Mapper方法:

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

3.boolean deleteTopicBySeminarId(BigInteger topicId)

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

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

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

*调用的Mapper方法:

1.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方法:

1.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.经纬度海拔类

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

co���x:��

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 205,033评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 87,725评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 151,473评论 0赞 338
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,846评论 1赞 277
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,848评论 5赞 368
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,691评论 1赞 282
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 38,053评论 3赞 399
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,700评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 42,856评论 1赞 300
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,676评论 2赞 323
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,787评论 1赞 333
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,430评论 4赞 321
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 39,034评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,990评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,218评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 45,174评论 2赞 352
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,526评论 2赞 343