edu.ksu.canvas.model

Class BaseCanvasModel

java.lang.Object

edu.ksu.canvas.model.BaseCanvasModel

Direct Known Subclasses:

Account, AccountReportSummary, Assignment, AssignmentGroup, AssignmentOverride, AuthenticationLog, CalendarEvent, CalendarEvent.ChildEvent, CommunicationChannel, ContentMigration, Conversation, Course, CourseSettings, Enrollment, EnrollmentTerm, ExternalTool, Feature, GradingRules, GradingStandard, Login, MediaComment, MigrationIssue, Module, Page, Quiz, QuizQuestion, QuizSubmission, Role, Rubric, RubricAssessment, RubricAssociation, RubricCriterion, RubricRating, RubricSettings, Section, SelectiveData, SisImport, Submission, Submission.SubmissionRubricAssessment, SubmissionComment, Tab, User

public abstract class BaseCanvasModel
extends Object

Constructor Summary

Constructors

Constructor and Description
BaseCanvasModel()

Method Summary

Modifier and Type	Method and Description
com.google.gson.JsonObject	toJsonObject(Boolean serializeNulls) Wraps a Canvas model inside of a JSON object so that the resulting serialized object can be pushed to Canvas create/edit endpoints.
Map<String,List<String>>	toPostMap(boolean includeNulls)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseCanvasModel

public BaseCanvasModel()

Method Detail

toPostMap

public Map<String,List<String>> toPostMap(boolean includeNulls)

toJsonObject

public com.google.gson.JsonObject toJsonObject(Boolean serializeNulls)

Wraps a Canvas model inside of a JSON object so that the resulting serialized object can be pushed to Canvas create/edit endpoints. For example, to create an assignment, the JSON must look like:

{assignment: {name: "Assignment 1"}}

. This method adds the outer "assignment" container based on CanvasObject notations on the model classes

Parameters:

serializeNulls - Whether or not to include null fields in the serialized JSON. Defaults to false if null

Returns:

A JsonObject suitable for serializing out to the Canvas API