Added list module items API.

Author: anguslee-wse

src/main/java/edu/ksu/canvas/CanvasApiFactory.java

@@ -179,6 +179,7 @@ private void setupClassMap() {
         readerMap.put(CourseSettingsReader.class, CourseSettingsImpl.class);
         readerMap.put(GradingStandardReader.class, GradingStandardImpl.class);
         readerMap.put(ModuleReader.class, ModuleImpl.class);
+        readerMap.put(ModuleItemReader.class, ModuleItemImpl.class);
         readerMap.put(SisImportReader.class, SisImportImpl.class);
         readerMap.put(SelectiveDataReader.class, SelectiveDataImpl.class);
         readerMap.put(MigrationIssueReader.class, MigrationIssueImpl.class);

src/main/java/edu/ksu/canvas/impl/ModuleItemImpl.java

@@ -0,0 +1,41 @@
+package edu.ksu.canvas.impl;
+
+import com.google.gson.reflect.TypeToken;
+import edu.ksu.canvas.interfaces.CanvasWriter;
+import edu.ksu.canvas.interfaces.ModuleItemReader;;
+import edu.ksu.canvas.model.ModuleItem;
+import edu.ksu.canvas.net.RestClient;
+import edu.ksu.canvas.oauth.OauthToken;
+import edu.ksu.canvas.requestOptions.ListModuleItemsOptions;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.lang.reflect.Type;
+import java.util.List;
+
+public class ModuleItemImpl extends BaseImpl<ModuleItem, ModuleItemReader, CanvasWriter> implements ModuleItemReader {
+	private static final Logger LOG = LoggerFactory.getLogger(ModuleItemImpl.class);
+	public ModuleItemImpl(final String canvasBaseUrl, final Integer apiVersion, final OauthToken oauthToken, final RestClient restClient, final int connectTimeout, final int readTimeout, final Integer paginationPageSize, final Boolean serializeNulls) {
+		super(canvasBaseUrl, apiVersion, oauthToken, restClient, connectTimeout, readTimeout, paginationPageSize, serializeNulls);
+	}
+
+	@Override
+	public List<ModuleItem> getModuleItemsInModule(final ListModuleItemsOptions options) throws IOException {
+		LOG.debug("Retrieving items for module {}", options.getModuleId());
+		String url = buildCanvasUrl(String.format("courses/%d/modules/%d/items", options.getCourseId(), options.getModuleId()), options.getOptionsMap());
+		return getListFromCanvas(url);
+	}
+
+	@Override
+	protected Type listType() {
+		return new TypeToken<List<ModuleItem>>() {
+		}.getType();
+	}
+
+	@Override
+	protected Class<ModuleItem> objectType() {
+		return ModuleItem.class;
+	}
+}

src/main/java/edu/ksu/canvas/interfaces/ModuleItemReader.java

@@ -0,0 +1,18 @@
+package edu.ksu.canvas.interfaces;
+
+import edu.ksu.canvas.model.ModuleItem;
+import edu.ksu.canvas.requestOptions.ListModuleItemsOptions;
+
+import java.io.IOException;
+import java.util.List;
+
+public interface ModuleItemReader extends CanvasReader<ModuleItem, ModuleItemReader> {
+	/**
+	 * Retrieve the list of items in a module.
+	 *
+	 * @param options The object holding options for this API call
+	 * @return List of the items in a module
+	 * @throws IOException When there is an error communicating with Canvas
+	 */
+	public List<ModuleItem> getModuleItemsInModule(ListModuleItemsOptions options) throws IOException;
+}

src/main/java/edu/ksu/canvas/model/ModuleItem.java

@@ -0,0 +1,124 @@
+package edu.ksu.canvas.model;
+
+import java.io.Serializable;
+
+/* https://canvas.instructure.com/doc/api/modules.html#ModuleItem */
+public class ModuleItem extends BaseCanvasModel implements Serializable {
+	private Long id;
+	private Long moduleId;
+	private Long position;
+	private String title;
+	private Long indent;
+	private String type;
+	private Long contentId;
+	private String htmlUrl;
+	private String url; /* optional */
+	private String pageUrl; /* only for 'Page' type */
+	private String externalUrl; /* only for 'ExternalUrl' and 'ExternalTool' types */
+	private Boolean newTab; /* only for 'ExternalTool' type */
+	private Boolean published;
+
+	public Long getId() {
+		return id;
+	}
+
+	public void setId(Long id) {
+		this.id = id;
+	}
+
+	public Long getModuleId() {
+		return moduleId;
+	}
+
+	public void setModuleId(Long moduleId) {
+		this.moduleId = moduleId;
+	}
+
+	public Long getPosition() {
+		return position;
+	}
+
+	public void setPosition(Long position) {
+		this.position = position;
+	}
+
+	public String getTitle() {
+		return title;
+	}
+
+	public void setTitle(String title) {
+		this.title = title;
+	}
+
+	public Long getIndent() {
+		return indent;
+	}
+
+	public void setIndent(Long indent) {
+		this.indent = indent;
+	}
+
+	public String getType() {
+		return type;
+	}
+
+	public void setType(String type) {
+		this.type = type;
+	}
+
+	public long getContentId() {
+		return contentId;
+	}
+
+	public void setContenId(long contentId) {
+		this.contentId = contentId;
+	}
+
+	public String getHtmlUrl() {
+		return htmlUrl;
+	}
+
+	public void setHtmlUrl(String htmlUrl) {
+		this.htmlUrl = htmlUrl;
+	}
+
+	public String getUrl() {
+		return url;
+	}
+
+	public void setUrl(String url) {
+		this.url = url;
+	}
+
+	public String getPageUrl() {
+		return pageUrl;
+	}
+
+	public void setPageUrl(String pageUrl) {
+		this.pageUrl = pageUrl;
+	}
+
+	public String getExternalUrl() {
+		return externalUrl;
+	}
+
+	public void setExternalUrl(String externalUrl) {
+		this.externalUrl = externalUrl;
+	}
+
+	public java.lang.Boolean getNewTab() {
+		return newTab;
+	}
+
+	public void setNewTab(java.lang.Boolean newTab) {
+		this.newTab = newTab;
+	}
+
+	public Boolean getPublished() {
+		return published;
+	}
+
+	public void setPublished(Boolean published) {
+		this.published = published;
+	}
+}

src/main/java/edu/ksu/canvas/requestOptions/ListModuleItemsOptions.java

@@ -0,0 +1,47 @@
+package edu.ksu.canvas.requestOptions;
+
+import java.util.List;
+
+/**
+ * Options for listing the items in a module.
+ *
+ * @see <a href="https://canvas.instructure.com/doc/api/modules.html#method.context_module_items_api.index">List module items</a>
+ */
+public class ListModuleItemsOptions extends BaseOptions {
+
+	public enum Include {
+		CONTENT_DETAILS
+	}
+
+	private Long courseId;
+
+	private Long moduleId;
+
+	public ListModuleItemsOptions(Long courseId, Long moduleId) {
+		this.courseId = courseId;
+		this.moduleId = moduleId;
+	}
+
+	public Long getCourseId() {
+		return courseId;
+	}
+
+	public Long getModuleId() {
+		return moduleId;
+	}
+
+	public ListModuleItemsOptions includes(List<Include> includes) {
+		addEnumList("include[]", includes);
+		return this;
+	}
+
+	public ListModuleItemsOptions searchTerm(String searchTerm) {
+		addSingleItem("search_term", searchTerm);
+		return this;
+	}
+
+	public ListModuleItemsOptions studentId(String studentId) {
+		addSingleItem("student_id", studentId);
+		return this;
+	}
+}