MoodleSection.java

package in.co.praveenkumar.mdroid.model;

import java.util.ArrayList;
import java.util.List;

import com.google.gson.annotations.SerializedName;
import com.orm.SugarRecord;
import com.orm.dsl.Ignore;

public class MoodleSection extends SugarRecord<MoodleSection> {
	/**
	 * A section can be a week of contents or whatever the admin sets it.
	 */

	// since id is a reserved field in SugarRecord
	@SerializedName("id")
	int sectionid;

	@SerializedName("name")
	String name;

	@SerializedName("visible")
	int visible;

	@SerializedName("summary")
	String summary;

	@SerializedName("summaryformat")
	int summaryformat;

	@Ignore
	@SerializedName("modules")
	ArrayList<MoodleModule> modules;

	// Relational parameters
	Long parentid;
	int courseid;
	Long siteid;

	/**
	 * Section ID
	 * 
	 * @return
	 */
	public int getSectionid() {
		return sectionid;
	}

	/**
	 * Section name
	 * 
	 * @return
	 */
	public String getName() {
		return name;
	}

	/**
	 * Is the section visible
	 * 
	 * @return
	 */
	public int getVisible() {
		return visible;
	}

	/**
	 * Section description
	 * 
	 * @return
	 */
	public String getSummary() {
		return summary;
	}

	/**
	 * summary format (1 = HTML, 0 = MOODLE, 2 = PLAIN or 4 = MARKDOWN)
	 * 
	 * @return
	 */
	public int getSummaryformat() {
		return summaryformat;
	}

	/**
	 * list of modules in this section
	 * 
	 * @return
	 */
	public ArrayList<MoodleModule> getModules() {
		return modules;
	}

	/**
	 * Set the list of modules in this section <br/>
	 * Used while fetching course contents from database.
	 * 
	 * @return
	 */
	public void setModules(List<MoodleModule> modules) {
		this.modules = new ArrayList<>(modules);
	}

	/**
	 * Get the database id of the parent course. Not to be confused with actual
	 * courseid from Moodle site. This id is given by Sugar db while saving the
	 * parent
	 * 
	 * @return
	 */
	public Long getParentid() {
		return parentid;
	}

	/**
	 * courseid of the course to which this section belongs to. This id is given
	 * to a course by Moodle site
	 * 
	 * @return
	 */
	public int getCourseid() {
		return courseid;
	}

	/**
	 * Get the siteid of the Moodle site to which this section belong to. siteid
	 * is given to an user account by sugar db on successful login
	 * 
	 * @return
	 */
	public Long getSiteid() {
		return siteid;
	}

	/**
	 * Set the course db id
	 * 
	 * @param parentid
	 */
	public void setParentid(Long parentid) {
		this.parentid = parentid;
	}

	/**
	 * Set the course Moodle id
	 * 
	 * @param courseid
	 */
	public void setCourseid(int courseid) {
		this.courseid = courseid;
	}

	/**
	 * Set the siteid to which this course content belong to.
	 * 
	 * @param siteid
	 */
	public void setSiteid(Long siteid) {
		this.siteid = siteid;
	}

}