Course (Canvas API Library 1.8.0 API)

java.lang.Object
- edu.ksu.canvas.model.BaseCanvasModel
- - edu.ksu.canvas.model.Course

All Implemented Interfaces:

Serializable
```
public class Course
extends BaseCanvasModel
implements Serializable
```
Class to represent Canvas courses. See Canvas courses documentation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Course.CourseEvent

Nested Classes
Modifier and Type	Class and Description
`static class`	`Course.CourseEvent`

Field Summary

Fields
Modifier and Type Field and Description

static long serialVersionUID

Fields
Modifier and Type	Field and Description
`static long`	`serialVersionUID`

Constructor Summary

Constructors
Constructor and Description

Course()

Constructors
Constructor and Description
`Course()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Account`	`getAccount()`
`Integer`	`getAccountId()`
`Boolean`	`getAllowStudentForumAttachments()`
`Boolean`	`getAllowStudentWikiEdits()`
`Boolean`	`getAllowWikiComments()`
`Boolean`	`getApplyAssignmentGroupWeights()`
`Boolean`	`getBlueprint()`
`Boolean`	`getConcluded()`
`String`	`getCourseCode()`
`String`	`getCourseFormat()`
`Date`	`getCreatedAt()`
`String`	`getDefaultView()`
`Boolean`	`getEnableSisReactivation()`
`Date`	`getEndAt()`
`Boolean`	`getEnrollMe()`
`List<Enrollment>`	`getEnrollments()`
`EnrollmentTerm`	`getEnrollmentTerm()`
`long`	`getEnrollmentTermId()`
`Course.CourseEvent`	`getEvent()`
`Long`	`getGradingStandardId()`
`Boolean`	`getHideFinalGrades()`
`Long`	`getId()`
`String`	`getImageDownloadUrl()` Get the URL to download the course image, this is optional data and you need to request that Canvas include it.
`Integer`	`getImageId()`
`String`	`getImageUrl()`
`String`	`getIntegrationId()`
`Boolean`	`getIsPublic()`
`Boolean`	`getIsPublicToAuthUsers()`
`String`	`getLicense()`
`String`	`getName()`
`Boolean`	`getOffer()`
`Boolean`	`getOpenEnrollment()`
`String`	`getPublicDescription()`
`Boolean`	`getPublicSyllabus()`
`Boolean`	`getPublicSyllabusToAuth()`
`Boolean`	`getRestrictEnrollmentsToCourseDates()`
`List<Section>`	`getSections()`
`Boolean`	`getSelfEnrollment()`
`String`	`getSisCourseId()`
`Date`	`getStartAt()`
`Long`	`getStorageQuotaMb()`
`String`	`getSubaccountName()`
`String`	`getSyllabusBody()`
`List<UserDisplay>`	`getTeachers()`
`String`	`getTermId()`
`String`	`getTimeZone()`
`Integer`	`getTotalStudents()`
`String`	`getWorkflowState()`
`void`	`setAccount(Account account)`
`void`	`setAccountId(Integer accountId)`
`void`	`setAllowStudentForumAttachments(Boolean allowStudentForumAttachments)`
`void`	`setAllowStudentWikiEdits(Boolean allowStudentWikiEdits)`
`void`	`setAllowWikiComments(Boolean allowWikiComments)`
`void`	`setApplyAssignmentGroupWeights(Boolean applyAssignmentGroupWeights)`
`void`	`setBlueprint(Boolean blueprint)`
`void`	`setCourseCode(String courseCode)`
`void`	`setCourseFormat(String courseFormat)`
`void`	`setCreatedAt(Date createdAt)`
`void`	`setDefaultView(String defaultView)`
`void`	`setEnableSisReactivation(Boolean enableSisReactivation)`
`void`	`setEndAt(Date endAt)`
`void`	`setEnrollMe(Boolean enrollMe)`
`void`	`setEnrollments(List<Enrollment> enrollments)`
`void`	`setEnrollmentTerm(EnrollmentTerm enrollmentTerm)`
`void`	`setEnrollmentTermId(long enrollmentTermId)`
`void`	`setEvent(Course.CourseEvent event)` Cause a course status event when updating course in Canvas.
`void`	`setGradingStandardId(Long gradingStandardId)`
`void`	`setHideFinalGrades(Boolean hideFinalGrades)`
`void`	`setId(Long id)`
`void`	`setImageDownloadUrl(String imageDownloadUrl)`
`void`	`setImageId(Integer imageId)`
`void`	`setImageUrl(String imageUrl)`
`void`	`setIntegrationId(String integrationId)`
`void`	`setIsPublic(Boolean isPublic)`
`void`	`setIsPublicToAuthUsers(Boolean isPublicToAuthUsers)`
`void`	`setLicense(String license)`
`void`	`setName(String name)`
`void`	`setOffer(Boolean offer)`
`void`	`setOpenEnrollment(Boolean openEnrollment)`
`void`	`setPublicDescription(String publicDescription)`
`void`	`setPublicSyllabus(Boolean publicSyllabus)`
`void`	`setPublicSyllabusToAuth(Boolean publicSyllabusToAuth)`
`void`	`setRestrictEnrollmentsToCourseDates(Boolean restrictEnrollmentsToCourseDates)`
`void`	`setSections(List<Section> sections)`
`void`	`setSelfEnrollment(Boolean selfEnrollment)`
`void`	`setSisCourseId(String sisCourseId)`
`void`	`setStartAt(Date startAt)`
`void`	`setStorageQuotaMb(Long storageQuotaMb)`
`void`	`setSubaccountName(String subaccountName)`
`void`	`setSyllabusBody(String syllabusBody)`
`void`	`setTeachers(List<UserDisplay> teachers)`
`void`	`setTermId(String termId)`
`void`	`setTimeZone(String timeZone)`
`void`	`setTotalStudents(Integer totalStudents)`
`void`	`setWorkflowState(String workflowState)`

Methods inherited from class edu.ksu.canvas.model.BaseCanvasModel
toJsonObject, toPostMap

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail
- serialVersionUID
```
public static final long serialVersionUID
```
  See Also:
  
  Constant Field Values

Constructor Detail
- Course
```
public Course()
```

Method Detail

getEnrollmentTermId
```
public long getEnrollmentTermId()
```

setEnrollmentTermId

public void setEnrollmentTermId(long enrollmentTermId)

getAccountId
```
public Integer getAccountId()
```

setAccountId

public void setAccountId(Integer accountId)

getCourseCode
```
public String getCourseCode()
```

setCourseCode

public void setCourseCode(String courseCode)

getDefaultView
```
public String getDefaultView()
```

setDefaultView

public void setDefaultView(String defaultView)

getId
```
public Long getId()
```

setId
```
public void setId(Long id)
```

getName
```
public String getName()
```

setName
```
public void setName(String name)
```

getCreatedAt
```
public Date getCreatedAt()
```

setCreatedAt

public void setCreatedAt(Date createdAt)

getStartAt
```
public Date getStartAt()
```

setStartAt
```
public void setStartAt(Date startAt)
```

getEndAt
```
public Date getEndAt()
```

setEndAt
```
public void setEndAt(Date endAt)
```

getPublicSyllabus
```
public Boolean getPublicSyllabus()
```

setPublicSyllabus

public void setPublicSyllabus(Boolean publicSyllabus)

getStorageQuotaMb
```
public Long getStorageQuotaMb()
```

setStorageQuotaMb

public void setStorageQuotaMb(Long storageQuotaMb)

getHideFinalGrades
```
public Boolean getHideFinalGrades()
```

setHideFinalGrades

public void setHideFinalGrades(Boolean hideFinalGrades)

getApplyAssignmentGroupWeights

public Boolean getApplyAssignmentGroupWeights()

setApplyAssignmentGroupWeights

public void setApplyAssignmentGroupWeights(Boolean applyAssignmentGroupWeights)

getSisCourseId
```
public String getSisCourseId()
```

setSisCourseId

public void setSisCourseId(String sisCourseId)

getIntegrationId
```
public String getIntegrationId()
```

setIntegrationId

public void setIntegrationId(String integrationId)

getWorkflowState
```
public String getWorkflowState()
```

setWorkflowState

public void setWorkflowState(String workflowState)

getTotalStudents
```
public Integer getTotalStudents()
```

setTotalStudents

public void setTotalStudents(Integer totalStudents)

getEnrollmentTerm

public EnrollmentTerm getEnrollmentTerm()

setEnrollmentTerm

public void setEnrollmentTerm(EnrollmentTerm enrollmentTerm)

getSections
```
public List<Section> getSections()
```

setSections

public void setSections(List<Section> sections)

getEnrollments

public List<Enrollment> getEnrollments()

setEnrollments

public void setEnrollments(List<Enrollment> enrollments)

getRestrictEnrollmentsToCourseDates

public Boolean getRestrictEnrollmentsToCourseDates()

setRestrictEnrollmentsToCourseDates

public void setRestrictEnrollmentsToCourseDates(Boolean restrictEnrollmentsToCourseDates)

getGradingStandardId
```
public Long getGradingStandardId()
```

setGradingStandardId

public void setGradingStandardId(Long gradingStandardId)

getSubaccountName
```
public String getSubaccountName()
```

setSubaccountName

public void setSubaccountName(String subaccountName)

getTeachers

public List<UserDisplay> getTeachers()

setTeachers

public void setTeachers(List<UserDisplay> teachers)

getLicense
```
public String getLicense()
```

setLicense

public void setLicense(String license)

getIsPublic
```
public Boolean getIsPublic()
```

setIsPublic

public void setIsPublic(Boolean isPublic)

getIsPublicToAuthUsers

public Boolean getIsPublicToAuthUsers()

setIsPublicToAuthUsers

public void setIsPublicToAuthUsers(Boolean isPublicToAuthUsers)

getPublicSyllabusToAuth

public Boolean getPublicSyllabusToAuth()

setPublicSyllabusToAuth

public void setPublicSyllabusToAuth(Boolean publicSyllabusToAuth)

getAllowStudentWikiEdits

public Boolean getAllowStudentWikiEdits()

setAllowStudentWikiEdits

public void setAllowStudentWikiEdits(Boolean allowStudentWikiEdits)

getAllowWikiComments
```
public Boolean getAllowWikiComments()
```

setAllowWikiComments

public void setAllowWikiComments(Boolean allowWikiComments)

getAllowStudentForumAttachments

public Boolean getAllowStudentForumAttachments()

setAllowStudentForumAttachments

public void setAllowStudentForumAttachments(Boolean allowStudentForumAttachments)

getOpenEnrollment
```
public Boolean getOpenEnrollment()
```

setOpenEnrollment

public void setOpenEnrollment(Boolean openEnrollment)

getSelfEnrollment
```
public Boolean getSelfEnrollment()
```

setSelfEnrollment

public void setSelfEnrollment(Boolean selfEnrollment)

getTermId
```
public String getTermId()
```

setTermId
```
public void setTermId(String termId)
```

getTimeZone
```
public String getTimeZone()
```

setTimeZone

public void setTimeZone(String timeZone)

getOffer
```
public Boolean getOffer()
```

setOffer
```
public void setOffer(Boolean offer)
```

getEnrollMe
```
public Boolean getEnrollMe()
```

setEnrollMe

public void setEnrollMe(Boolean enrollMe)

getSyllabusBody
```
public String getSyllabusBody()
```

setSyllabusBody

public void setSyllabusBody(String syllabusBody)

getCourseFormat
```
public String getCourseFormat()
```

setCourseFormat

public void setCourseFormat(String courseFormat)

getEnableSisReactivation

public Boolean getEnableSisReactivation()

setEnableSisReactivation

public void setEnableSisReactivation(Boolean enableSisReactivation)

getAccount
```
public Account getAccount()
```

setAccount

public void setAccount(Account account)

getImageId
```
public Integer getImageId()
```

setImageId

public void setImageId(Integer imageId)

getImageUrl
```
public String getImageUrl()
```

setImageUrl

public void setImageUrl(String imageUrl)

getImageDownloadUrl
```
public String getImageDownloadUrl()
```
Get the URL to download the course image, this is optional data and you need to request that Canvas include it.

Returns:

The public URL to download the course image.

See Also:

GetSingleCourseOptions.Include.COURSE_IMAGE

setImageDownloadUrl

public void setImageDownloadUrl(String imageDownloadUrl)

getBlueprint
```
public Boolean getBlueprint()
```

setBlueprint

public void setBlueprint(Boolean blueprint)

getConcluded
```
public Boolean getConcluded()
```

getPublicDescription
```
public String getPublicDescription()
```

setPublicDescription

public void setPublicDescription(String publicDescription)

getEvent
```
public Course.CourseEvent getEvent()
```

setEvent
```
public void setEvent(Course.CourseEvent event)
```
Cause a course status event when updating course in Canvas. See "event" parameter for details: https://canvas.instructure.com/doc/api/courses.html#method.courses.update

Parameters:

event - The event to trigger (publish, conclude, etc)

Class Course

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class edu.ksu.canvas.model.BaseCanvasModel

Methods inherited from class java.lang.Object

Field Detail

serialVersionUID

Constructor Detail

Course

Method Detail

getEnrollmentTermId

setEnrollmentTermId

getAccountId

setAccountId

getCourseCode

setCourseCode

getDefaultView

setDefaultView

getId

setId

getName

setName

getCreatedAt

setCreatedAt

getStartAt

setStartAt

getEndAt

setEndAt

getPublicSyllabus

setPublicSyllabus

getStorageQuotaMb

setStorageQuotaMb

getHideFinalGrades

setHideFinalGrades

getApplyAssignmentGroupWeights

setApplyAssignmentGroupWeights

getSisCourseId

setSisCourseId

getIntegrationId

setIntegrationId

getWorkflowState

setWorkflowState

getTotalStudents

setTotalStudents

getEnrollmentTerm

setEnrollmentTerm

getSections

setSections

getEnrollments

setEnrollments

getRestrictEnrollmentsToCourseDates

setRestrictEnrollmentsToCourseDates

getGradingStandardId

setGradingStandardId

getSubaccountName

setSubaccountName

getTeachers

setTeachers

getLicense

setLicense

getIsPublic

setIsPublic

getIsPublicToAuthUsers

setIsPublicToAuthUsers

getPublicSyllabusToAuth

setPublicSyllabusToAuth

getAllowStudentWikiEdits

setAllowStudentWikiEdits

getAllowWikiComments

setAllowWikiComments

getAllowStudentForumAttachments

setAllowStudentForumAttachments

getOpenEnrollment

setOpenEnrollment

getSelfEnrollment

setSelfEnrollment

getTermId

setTermId