PortfolioElementRow.java

/**
 * <a href="http://www.openolat.org">
 * OpenOLAT - Online Learning and Training</a><br>
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License"); <br>
 * you may not use this file except in compliance with the License.<br>
 * You may obtain a copy of the License at the
 * <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache homepage</a>
 * <p>
 * Unless required by applicable law or agreed to in writing,<br>
 * software distributed under the License is distributed on an "AS IS" BASIS, <br>
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
 * See the License for the specific language governing permissions and <br>
 * limitations under the License.
 * <p>
 * Initial code contributed and copyrighted by<br>
 * frentix GmbH, http://www.frentix.com
 * <p>
 */
package org.olat.modules.portfolio.ui.model;

import java.util.Collection;
import java.util.Date;

import org.olat.core.gui.components.form.flexible.elements.FormLink;
import org.olat.core.gui.components.image.ImageComponent;
import org.olat.core.util.StringHelper;
import org.olat.course.assessment.AssessmentHelper;
import org.olat.modules.portfolio.AssessmentSection;
import org.olat.modules.portfolio.Assignment;
import org.olat.modules.portfolio.Page;
import org.olat.modules.portfolio.PageStatus;
import org.olat.modules.portfolio.Section;
import org.olat.modules.portfolio.SectionStatus;

/**
 * 
 * Initial date: 08.06.2016<br>
 * @author srosse, stephane.rosse@frentix.com, http://www.frentix.com
 *
 */
public class PortfolioElementRow {
	
	private final Page page;
	private final Section section;
	private Assignment assignment;
	private final AssessmentSection assessmentSection;
	
	private String imageUrl;
	
	private String metaSectionTitle;
	private String metaBinderTitle;
	
	private final boolean assessable;
	private final boolean assignments;
	// calculated by the sort
	private boolean lastAssignmentToInstantiate;
	// calculated by the sort
	private boolean sectionWithAssignmentToInstantiate;

	private Collection<String> pageCategories;
	private Collection<String> sectionCategories;

	private long numOfComments;

	private FormLink commentFormLink, openFormLink,
		newFloatingEntryLink, newEntryLink,
		closeSectionLink, reopenSectionLink;
	// assignment
	private FormLink newAssignmentLink, editAssignmentLink, deleteAssignmentLink,
		instantiateAssignmentLink, upAssignmentLink, downAssignmentLink, moveAssignmentLink;
	
	private ImageComponent poster;
	
	private boolean newEntry;
	private RowType type;
	
	public PortfolioElementRow(Section section, AssessmentSection assessmentSection,
			boolean assessable, boolean assignments) {
		this.page = null;
		type = RowType.section;
		this.section = section;
		this.assessable = assessable;
		this.assignments = assignments;
		this.assessmentSection = assessmentSection;
	}
	
	public PortfolioElementRow(Page page, AssessmentSection assessmentSection,
			boolean assessable) {
		this.page = page;
		this.section = page.getSection();
		type = RowType.page;
		this.assessable = assessable;
		this.assignments = false;
		this.assessmentSection = assessmentSection;
	}
	
	private int assignmentPos;
	
	public PortfolioElementRow(Assignment assignment, Section section, int assignmentPos) {
		this.assignment = assignment;
		this.section = section;
		this.assignmentPos = assignmentPos;
		
		page = null;
		assessable = false;
		assignments = false;
		assessmentSection = null;
		type = RowType.pendingAssignment;
	}
	
	public boolean isPage() {
		return type == RowType.page;
	}
	
	public boolean isSection() {
		return type == RowType.section;
	}
	
	public boolean isPendingAssignment() {
		return type == RowType.pendingAssignment;
	}
	
	public boolean isNewEntry() {
		return newEntry;
	}
	
	public boolean isAssignments() {
		return assignments;
	}

	public void setNewEntry(boolean newEntry) {
		this.newEntry = newEntry;
	}

	public Long getKey() {
		return page == null ? null : page.getKey();
	}
	
	public Page getPage() {
		return page;
	}
	
	public String getTitle() {
		return page == null ? null : page.getTitle();
	}
	
	public String getSummary() {
		return page.getSummary();
	}
	
	public Date getLastModified() {
		return page.getLastModified();
	}
	
	public Date getCreationDate() {
		return page.getCreationDate();
	}
	
	public String getImageAlign() {
		return page.getImageAlignment() == null ? null : page.getImageAlignment().name();
	}
	
	public String getImageUrl() {
		return imageUrl;
	}

	public void setImageUrl(String imageUrl) {
		this.imageUrl = imageUrl;
	}

	public ImageComponent getPoster() {
		return poster;
	}

	public void setPoster(ImageComponent poster) {
		this.poster = poster;
	}

	public PageStatus getPageStatus() {
		return page == null ? null : page.getPageStatus();
	}
	
	public String getPageStatusI18nKey() {
		return (page == null || page.getPageStatus() == null ) ? PageStatus.draft.i18nKey() : page.getPageStatus().i18nKey();
	}
	
	public Date getLastPublicationDate() {
		return page == null ? null : page.getLastPublicationDate();
	}
	
	public String getCssClassStatus() {
		return page.getPageStatus() == null
				? PageStatus.draft.cssClass() : page.getPageStatus().cssClass();
	}
	
	public Section getSection() {
		return section;
	}
	
	public String getSectionTitle() {
		return section == null ? null : section.getTitle();
	}
	
	public SectionStatus getSectionStatus() {
		if(section == null || section.getSectionStatus() == null) {
			return SectionStatus.notStarted;
		}
		return section.getSectionStatus();
	}
	
	public String getSectionStatusI18nKey() {
		return getSectionStatus().i18nKey();
	}
	
	public String getSectionCssClassStatus() {
		if(section == null) {
			return null;
		}
		return section.getSectionStatus() == null ? SectionStatus.notStarted.cssClass() : section.getSectionStatus().cssClass();
	}
	
	public String getSectionLongTitle() {
		return section.getTitle();
	}
	
	public Date getSectionBeginDate() {
		return section.getBeginDate();
	}
	
	public Date getSectionEndDate() {
		return section.getEndDate();
	}
	
	public String getSectionDescription() {
		return section.getDescription();
	}
	
	public Collection<String> getPageCategories() {
		return pageCategories;
	}

	public void setPageCategories(Collection<String> pageCategories) {
		this.pageCategories = pageCategories;
	}
	
	public Collection<String> getSectionCategories() {
		return sectionCategories;
	}

	public void setSectionCategories(Collection<String> sectionCategories) {
		this.sectionCategories = sectionCategories;
	}

	public Assignment getAssignment() {
		return assignment;
	}

	public void setAssignment(Assignment assignment) {
		this.assignment = assignment;
	}
	
	public String getAssignmentTitle() {
		return assignment == null ? null : assignment.getTitle();
	}
	
	public String getAssignmentSummary() {
		return assignment == null ? null : assignment.getSummary();
	}
	
	public int getAssignmentPos() {
		return assignmentPos;
	}

	public boolean isAssessable() {
		return assessable;
	}
	
	public boolean hasScore() {
		return assessable && assessmentSection != null && assessmentSection.getScore() != null;
	}
	
	public String getScore() {
		if(assessmentSection != null && assessmentSection.getScore() != null) {
			return AssessmentHelper.getRoundedScore(assessmentSection.getScore());
		}
		return "";
	}
	
	public FormLink getNewEntryLink() {
		return newEntryLink;
	}
	
	public void setNewEntryLink(FormLink newEntryLink) {
		this.newEntryLink = newEntryLink;
	}
	
	public FormLink getNewFloatingEntryLink() {
		return newFloatingEntryLink;
	}

	public void setNewFloatingEntryLink(FormLink newFloatingEntryLink) {
		this.newFloatingEntryLink = newFloatingEntryLink;
	}
	
	public FormLink getOpenFormItem() {
		return openFormLink;
	}

	public void setOpenFormLink(FormLink openFormLink) {
		this.openFormLink = openFormLink;
	}

	public long getNumOfComments() {
		return numOfComments;
	}

	public void setNumOfComments(long numOfComments) {
		this.numOfComments = numOfComments;
	}

	public FormLink getCommentFormLink() {
		return commentFormLink;
	}

	public void setCommentFormLink(FormLink commentFormLink) {
		this.commentFormLink = commentFormLink;
	}

	public String[] getMetaBinderAndSectionTitles() {
		if(StringHelper.containsNonWhitespace(metaBinderTitle) && StringHelper.containsNonWhitespace(metaSectionTitle)) {
			return new String[]{ StringHelper.escapeHtml(metaBinderTitle), StringHelper.escapeHtml(metaSectionTitle) };
		}
		return null;
	}

	public void setMetaSectionTitle(String metaSectionTitle) {
		this.metaSectionTitle = metaSectionTitle;
	}
	
	public void setMetaBinderTitle(String metaBinderTitle) {
		this.metaBinderTitle = metaBinderTitle;
	}
	
	public FormLink getNewAssignmentLink() {
		return newAssignmentLink;
	}
	
	public void setNewAssignmentLink(FormLink newAssignmentLink) {
		this.newAssignmentLink = newAssignmentLink;
	}
	
	public FormLink getEditAssignmentLink() {
		return editAssignmentLink;
	}

	public void setEditAssignmentLink(FormLink editAssignmentLink) {
		this.editAssignmentLink = editAssignmentLink;
	}

	public FormLink getDeleteAssignmentLink() {
		return deleteAssignmentLink;
	}

	public void setDeleteAssignmentLink(FormLink deleteAssignmentLink) {
		this.deleteAssignmentLink = deleteAssignmentLink;
	}

	public FormLink getMoveAssignmentLink() {
		return moveAssignmentLink;
	}

	public void setMoveAssignmentLink(FormLink moveAssignmentLink) {
		this.moveAssignmentLink = moveAssignmentLink;
	}

	public FormLink getUpAssignmentLink() {
		return upAssignmentLink;
	}

	public void setUpAssignmentLink(FormLink upAssignmentLink) {
		this.upAssignmentLink = upAssignmentLink;
	}

	public FormLink getDownAssignmentLink() {
		return downAssignmentLink;
	}

	public void setDownAssignmentLink(FormLink downAssignmentLink) {
		this.downAssignmentLink = downAssignmentLink;
	}
	
	public boolean isLastAssignmentToInstantiate() {
		return lastAssignmentToInstantiate;
	}

	public void setLastAssignmentToInstantiate(boolean lastAssignmentToInstantiate) {
		this.lastAssignmentToInstantiate = lastAssignmentToInstantiate;
	}

	public boolean isSectionWithAssignmentToInstantiate() {
		return sectionWithAssignmentToInstantiate;
	}
	
	public void setSectionWithAssignmentToInstantiate(boolean instatiate) {
		sectionWithAssignmentToInstantiate = instatiate;
	}
	
	public boolean isAssignmentToInstantiate() {
		return instantiateAssignmentLink != null;
	}

	public FormLink getInstantiateAssignmentLink() {
		return instantiateAssignmentLink;
	}

	public void setInstantiateAssignmentLink(FormLink instantiateAssignmentLink) {
		this.instantiateAssignmentLink = instantiateAssignmentLink;
	}

	public FormLink getCloseSectionLink() {
		return closeSectionLink;
	}

	public void setCloseSectionLink(FormLink closeSectionLink) {
		this.closeSectionLink = closeSectionLink;
	}

	public FormLink getReopenSectionLink() {
		return reopenSectionLink;
	}

	public void setReopenSectionLink(FormLink reopenSectionLink) {
		this.reopenSectionLink = reopenSectionLink;
	}
	
	public enum RowType {
		section,
		page,
		pendingAssignment
	}
}