Skip to content

Commit

Permalink
LSNBLDR-420 additional data for lessons entitybroker feed
Browse files Browse the repository at this point in the history 
git-svn-id: https://source.sakaiproject.org/svn/lessonbuilder/trunk@315996 66ffb92e-73f9-0310-93c1-f5514f145a0a
  • Loading branch information
@bethkirschner
bethkirschner committed Dec 11, 2014
1 parent 2505744 commit 0b528dc
Show file tree
Hide file tree
Showing 2 changed files with 157 additions and 35 deletions.
191 changes: 156 additions & 35 deletions ...c/java/org/sakaiproject/lessonbuildertool/tool/entityproviders/LessonsEntityProvider.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
Expand Down Expand Up @@ -70,6 +71,8 @@
import org.sakaiproject.tool.api.ToolSession;
import org.sakaiproject.tool.api.ActiveTool;
import org.sakaiproject.component.cover.ServerConfigurationService;
import org.sakaiproject.content.api.ContentHostingService;
import org.sakaiproject.content.api.ContentResource;
import org.sakaiproject.thread_local.cover.ThreadLocalManager;
import org.sakaiproject.tool.cover.ActiveToolManager;
import org.sakaiproject.tool.api.Placement;
Expand Down Expand Up @@ -238,8 +241,12 @@ public List<?> getLessonsInSite(EntityView view, Map<String, Object> params) {
for(SimplePageItem item : list)
{
simplePageBean = makeSimplePageBean(simplePageBean, siteId, item);
if (hasUpdatePermission || lessonsAccess.isItemAccessible(item.getId(), siteId, currentUserId, simplePageBean))
ret.add(new DecoratedSiteItem(item.getId(), item.getName(), baseURL + item.getId()));
if (hasUpdatePermission || lessonsAccess.isItemAccessible(item.getId(), siteId, currentUserId, simplePageBean)) {
SimplePage currentSimplePage = simplePageBean.getCurrentPage();
if (currentSimplePage != null){
ret.add(new DecoratedSiteItem(item.getId(), item.getName(), baseURL + item.getId(), currentSimplePage.isHidden(), currentSimplePage.getReleaseDate(), currentSimplePage.getGradebookPoints()));
}
}
}

return ret;
Expand Down Expand Up @@ -378,7 +385,7 @@ public Object getLesson(EntityView view, Map<String, Object> params) {
if(simpleType)
ret.add(new DecoratedItem(item.getId(), item.getName(), item.getType(), site.getId(), site.getTitle()));
else
addItem(item, ret, hasUpdatePermission);
addItem(item, ret, hasUpdatePermission, page);
return ret.get(0);
}

Expand Down Expand Up @@ -446,6 +453,9 @@ public class DecoratedSiteItem {
private long id;
private String lessonTitle;
private String contentsURL;
private boolean hidden;
private Date releaseDate;
private Double gradebookPoints;
}

//for action=user
Expand Down Expand Up @@ -475,6 +485,7 @@ public class LessonBase {
private long pageId;
private boolean prerequisite;
private boolean required;
private String description;

public LessonBase(SimplePageItem item)
{
Expand All @@ -486,6 +497,7 @@ public LessonBase(SimplePageItem item)
this.pageId = item.getPageId();
this.prerequisite = item.isPrerequisite();
this.required = item.isRequired();
this.description = item.getDescription();
}
}
}
Expand Down Expand Up @@ -517,17 +529,104 @@ public DecoratedLesson(SimplePageItem item)
public class DecoratedLessonPage extends DecoratedLesson {
private String contentsURL;
private List<LessonBase> contentsList;
private boolean hidden;
private Date releaseDate;
private Double gradebookPoints;

public void setContentsList(List<LessonBase> list) {
contentsList = list;
}
public DecoratedLessonPage(SimplePageItem item) {
public DecoratedLessonPage(SimplePageItem item, SimplePage simplePage) {
super(item);
String baseURL = developerHelperService.getEntityURL(REFERENCE_ROOT, EntityView.VIEW_LIST, null); // /direct/lessons
baseURL = baseURL + "/lesson/";
this.contentsURL = baseURL + item.getId();
this.contentsList = null;

if (simplePage != null) {
this.hidden = simplePage.isHidden();
this.releaseDate = simplePage.getReleaseDate();
this.gradebookPoints = simplePage.getGradebookPoints();
}
}
}

//(based on LessonBase) for most cases
@NoArgsConstructor
@AllArgsConstructor
@Data
public class DecoratedResource extends DecoratedLesson{
private Boolean openInNewWindow;
private String contentType;

public DecoratedResource(SimplePageItem item)
{
super(item);
if(item != null)
{
this.openInNewWindow = !item.isSameWindow();

// retrieve the content type for this resource since the html
// field doesn't differentiate html from url resources
ContentResource resource = null;
try {
resource = contentHostingService.getResource(item.getSakaiId());
if (resource != null) {
this.contentType = resource.getContentType();
}
} catch (Exception e) {
log.warn("Exception when retrieving resource for sakaiId:" + item.getSakaiId() + ". " + e);
}
}
}
}

// For properties related to grading a DecoratedLesson
@NoArgsConstructor
@AllArgsConstructor
@Data
public class GradedDecoratedLesson extends DecoratedLesson{
private String requiredPointsEarned;

public GradedDecoratedLesson(SimplePageItem item)
{
super(item);
if(item != null && item.getSubrequirement())
{
this.requiredPointsEarned = item.getRequirementText();
}
}
}

@NoArgsConstructor
@AllArgsConstructor
@Data
public class DecoratedStudentContent extends DecoratedLesson{
private Integer contentGradebookPoints;
private Integer commentsGradebookPoints;
private boolean addCommentsSection;

public DecoratedStudentContent(SimplePageItem item)
{
super(item);
this.contentGradebookPoints = item.getGradebookPoints();
this.commentsGradebookPoints = item.getAltPoints();
this.addCommentsSection = item.getShowComments();
}
}

@NoArgsConstructor
@AllArgsConstructor
@Data
public class DecoratedComments extends DecoratedLesson {
private Integer gradebookPoints;

public DecoratedComments(SimplePageItem item)
{
super(item);
this.gradebookPoints = item.getGradebookPoints();
}
}

//for question items (base)
@NoArgsConstructor
Expand Down Expand Up @@ -739,9 +838,11 @@ private void findAllPages(SimplePageItem pageItem, List<LessonBase> entries, Map
if (pageMap.get(pageId) == null)
return;


SimplePage currPage = pageMap.get(pageId);
// say done
pageMap.remove(pageId);
LessonBase lessonPage = addItem(pageItem, entries, hasUpdatePermission);
LessonBase lessonPage = addItem(pageItem, entries, hasUpdatePermission, currPage);

// now recursively do subpages
List<SimplePageItem> items = simplePageToolDao.findItemsOnPage(pageId);
Expand All @@ -766,7 +867,7 @@ private void findAllPages(SimplePageItem pageItem, List<LessonBase> entries, Map
if (item.getType() == SimplePageItem.PAGE)
findAllPages(item, entries, pageMap, hasUpdatePermission, siteId, currentUserId );
else
addItem(item, entries, hasUpdatePermission);
addItem(item, entries, hasUpdatePermission, simplePageBean.getCurrentPage());
}
}
}
Expand Down Expand Up @@ -825,8 +926,9 @@ private void findAllSimplePages(SimplePageItem pageItem, List<DecoratedItem> ent
* @param item
* @param list
* @param hasUpdatePermission
* @param simplePage
*/
private LessonBase addItem(SimplePageItem item, List<LessonBase> list, boolean hasUpdatePermission)
private LessonBase addItem(SimplePageItem item, List<LessonBase> list, boolean hasUpdatePermission, SimplePage simplePage)
{
if(list == null)
list = new ArrayList<LessonBase>();
Expand All @@ -835,47 +937,63 @@ private LessonBase addItem(SimplePageItem item, List<LessonBase> list, boolean h
{
LessonBase lesson = null;
//check type
switch(item.getType())
{
switch (item.getType()) {
case SimplePageItem.QUESTION:
if("multipleChoice".equals(item.getAttribute("questionType"))) {
lesson = new DecoratedMultipleChoiceQuestion(item,
item.getAttribute("questionText"),
item.getAttribute("questionCorrectText"),
item.getAttribute("questionIncorrectText"),
item.getAttribute("questionGraded"),
item.getAttribute("questionShowPoll"));
List<SimplePageQuestionAnswer> answers = simplePageToolDao.findAnswerChoices(item);
for(SimplePageQuestionAnswer a : answers)
{
if ("multipleChoice".equals(item.getAttribute("questionType"))) {
lesson = new DecoratedMultipleChoiceQuestion(item,
item.getAttribute("questionText"),
item.getAttribute("questionCorrectText"),
item.getAttribute("questionIncorrectText"),
item.getAttribute("questionGraded"),
item.getAttribute("questionShowPoll"));

List<SimplePageQuestionAnswer> answers = simplePageToolDao
.findAnswerChoices(item);
for (SimplePageQuestionAnswer a : answers) {
DecoratedAnswerItem answer = new DecoratedAnswerItem();
answer.setId(a.getId());
answer.setText(a.getText());
//only show correct value if has permissions
if(hasUpdatePermission)
// only show correct value if has permissions
if (hasUpdatePermission)
answer.setCorrect(a.isCorrect());

((DecoratedMultipleChoiceQuestion)lesson).addAnswer(answer);

((DecoratedMultipleChoiceQuestion) lesson)
.addAnswer(answer);
}

} else if("shortanswer".equals(item.getAttribute("questionType"))) {
lesson = new DecoratedShortAnswerQuestion(item,
item.getAttribute("questionText"),
item.getAttribute("questionCorrectText"),
item.getAttribute("questionIncorrectText"),
item.getAttribute("questionGraded"),
item.getAttribute("questionAnswer"));

} else if ("shortanswer".equals(item
.getAttribute("questionType"))) {
lesson = new DecoratedShortAnswerQuestion(item,
item.getAttribute("questionText"),
item.getAttribute("questionCorrectText"),
item.getAttribute("questionIncorrectText"),
item.getAttribute("questionGraded"),
item.getAttribute("questionAnswer"));
}
break;
case SimplePageItem.PAGE:
lesson = new DecoratedLessonPage(item);
case SimplePageItem.PAGE:
lesson = new DecoratedLessonPage(item, simplePage);
break;
case SimplePageItem.RESOURCE:
lesson = new DecoratedResource(item);
break;
case SimplePageItem.ASSIGNMENT:
lesson = new GradedDecoratedLesson(item);
break;
case SimplePageItem.ASSESSMENT:
lesson = new GradedDecoratedLesson(item);
break;
case SimplePageItem.STUDENT_CONTENT:
lesson = new DecoratedStudentContent(item);
break;
case SimplePageItem.COMMENTS:
lesson = new DecoratedComments(item);
break;
default:
lesson = new DecoratedLesson(item);
break;
}

list.add(lesson);
return lesson;
}
Expand All @@ -902,5 +1020,8 @@ private LessonBase addItem(SimplePageItem item, List<LessonBase> list, boolean h

@Setter
private DeveloperHelperService developerHelperService;

@Setter
private ContentHostingService contentHostingService;

}
1 change: 1 addition & 0 deletions lessonbuilder/tool/src/webapp/WEB-INF/applicationContext.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -372,6 +372,7 @@ simplePageBean.peerEvalAllowSelfGrade
<property name="simplePageToolDao" ref="org.sakaiproject.lessonbuildertool.model.SimplePageToolDao" />
<property name="lessonsAccess" ref="org.sakaiproject.lessonbuildertool.service.LessonsAccess" />
<property name="developerHelperService" ref="org.sakaiproject.entitybroker.DeveloperHelperService" />
<property name="contentHostingService" ref="org.sakaiproject.content.api.ContentHostingService" />
</bean>

<bean id="org.sakaiproject.lessonbuildertool.service.LessonsAccess"
Expand Down

0 comments on commit 0b528dc

Please sign in to comment.