com.google.api.services.classroom.model

Class CourseWork

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.classroom.model.CourseWork

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class CourseWork
extends GenericJson

Course work created by a teacher for students of the course.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Classroom API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
CourseWork()

Method Summary

Modifier and Type	Method and Description
CourseWork	clone()
String	getAlternateLink() Absolute link to this course work in the Classroom web UI.
String	getAssigneeMode() Assignee mode of the coursework.
Assignment	getAssignment() Assignment details.
Boolean	getAssociatedWithDeveloper() Whether this course work item is associated with the Developer Console project making the request.
String	getCourseId() Identifier of the course.
String	getCreationTime() Timestamp when this course work was created.
String	getCreatorUserId() Identifier for the user that created the coursework.
String	getDescription() Optional description of this course work.
Date	getDueDate() Optional date, in UTC, that submissions for this course work are due.
TimeOfDay	getDueTime() Optional time of day, in UTC, that submissions for this course work are due.
GradeCategory	getGradeCategory() The category that this coursework's grade contributes to.
String	getId() Classroom-assigned identifier of this course work, unique per course.
IndividualStudentsOptions	getIndividualStudentsOptions() Identifiers of students with access to the coursework.
List<Material>	getMaterials() Additional materials.
Double	getMaxPoints() Maximum grade for this course work.
MultipleChoiceQuestion	getMultipleChoiceQuestion() Multiple choice question details.
String	getScheduledTime() Optional timestamp when this course work is scheduled to be published.
String	getState() Status of this course work.
String	getSubmissionModificationMode() Setting to determine when students are allowed to modify submissions.
String	getTitle() Title of this course work.
String	getTopicId() Identifier for the topic that this coursework is associated with.
String	getUpdateTime() Timestamp of the most recent change to this course work.
String	getWorkType() Type of this course work.
CourseWork	set(String fieldName, Object value)
CourseWork	setAlternateLink(String alternateLink) Absolute link to this course work in the Classroom web UI.
CourseWork	setAssigneeMode(String assigneeMode) Assignee mode of the coursework.
CourseWork	setAssignment(Assignment assignment) Assignment details.
CourseWork	setAssociatedWithDeveloper(Boolean associatedWithDeveloper) Whether this course work item is associated with the Developer Console project making the request.
CourseWork	setCourseId(String courseId) Identifier of the course.
CourseWork	setCreationTime(String creationTime) Timestamp when this course work was created.
CourseWork	setCreatorUserId(String creatorUserId) Identifier for the user that created the coursework.
CourseWork	setDescription(String description) Optional description of this course work.
CourseWork	setDueDate(Date dueDate) Optional date, in UTC, that submissions for this course work are due.
CourseWork	setDueTime(TimeOfDay dueTime) Optional time of day, in UTC, that submissions for this course work are due.
CourseWork	setGradeCategory(GradeCategory gradeCategory) The category that this coursework's grade contributes to.
CourseWork	setId(String id) Classroom-assigned identifier of this course work, unique per course.
CourseWork	setIndividualStudentsOptions(IndividualStudentsOptions individualStudentsOptions) Identifiers of students with access to the coursework.
CourseWork	setMaterials(List<Material> materials) Additional materials.
CourseWork	setMaxPoints(Double maxPoints) Maximum grade for this course work.
CourseWork	setMultipleChoiceQuestion(MultipleChoiceQuestion multipleChoiceQuestion) Multiple choice question details.
CourseWork	setScheduledTime(String scheduledTime) Optional timestamp when this course work is scheduled to be published.
CourseWork	setState(String state) Status of this course work.
CourseWork	setSubmissionModificationMode(String submissionModificationMode) Setting to determine when students are allowed to modify submissions.
CourseWork	setTitle(String title) Title of this course work.
CourseWork	setTopicId(String topicId) Identifier for the topic that this coursework is associated with.
CourseWork	setUpdateTime(String updateTime) Timestamp of the most recent change to this course work.
CourseWork	setWorkType(String workType) Type of this course work.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

CourseWork

public CourseWork()

Method Detail

getAlternateLink

public String getAlternateLink()

Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.

Returns:

value or null for none

setAlternateLink

public CourseWork setAlternateLink(String alternateLink)

Absolute link to this course work in the Classroom web UI. This is only populated if `state` is `PUBLISHED`. Read-only.

Parameters:

alternateLink - alternateLink or null for none

getAssigneeMode

public String getAssigneeMode()

Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`.

Returns:

value or null for none

setAssigneeMode

public CourseWork setAssigneeMode(String assigneeMode)

Assignee mode of the coursework. If unspecified, the default value is `ALL_STUDENTS`.

Parameters:

assigneeMode - assigneeMode or null for none

getAssignment

public Assignment getAssignment()

Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only.

Returns:

value or null for none

setAssignment

public CourseWork setAssignment(Assignment assignment)

Assignment details. This is populated only when `work_type` is `ASSIGNMENT`. Read-only.

Parameters:

assignment - assignment or null for none

getAssociatedWithDeveloper

public Boolean getAssociatedWithDeveloper()

Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.

Returns:

value or null for none

setAssociatedWithDeveloper

public CourseWork setAssociatedWithDeveloper(Boolean associatedWithDeveloper)

Whether this course work item is associated with the Developer Console project making the request. See CreateCourseWork for more details. Read-only.

Parameters:

associatedWithDeveloper - associatedWithDeveloper or null for none

getCourseId

public String getCourseId()

Identifier of the course. Read-only.

Returns:

value or null for none

setCourseId

public CourseWork setCourseId(String courseId)

Identifier of the course. Read-only.

Parameters:

courseId - courseId or null for none

getCreationTime

public String getCreationTime()

Timestamp when this course work was created. Read-only.

Returns:

value or null for none

setCreationTime

public CourseWork setCreationTime(String creationTime)

Timestamp when this course work was created. Read-only.

Parameters:

creationTime - creationTime or null for none

getCreatorUserId

public String getCreatorUserId()

Identifier for the user that created the coursework. Read-only.

Returns:

value or null for none

setCreatorUserId

public CourseWork setCreatorUserId(String creatorUserId)

Identifier for the user that created the coursework. Read-only.

Parameters:

creatorUserId - creatorUserId or null for none

getDescription

public String getDescription()

Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.

Returns:

value or null for none

setDescription

public CourseWork setDescription(String description)

Optional description of this course work. If set, the description must be a valid UTF-8 string containing no more than 30,000 characters.

Parameters:

description - description or null for none

getDueDate

public Date getDueDate()

Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified.

Returns:

value or null for none

setDueDate

public CourseWork setDueDate(Date dueDate)

Optional date, in UTC, that submissions for this course work are due. This must be specified if `due_time` is specified.

Parameters:

dueDate - dueDate or null for none

getDueTime

public TimeOfDay getDueTime()

Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified.

Returns:

value or null for none

setDueTime

public CourseWork setDueTime(TimeOfDay dueTime)

Optional time of day, in UTC, that submissions for this course work are due. This must be specified if `due_date` is specified.

Parameters:

dueTime - dueTime or null for none

getGradeCategory

public GradeCategory getGradeCategory()

The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only.

Returns:

value or null for none

setGradeCategory

public CourseWork setGradeCategory(GradeCategory gradeCategory)

The category that this coursework's grade contributes to. Present only when a category has been chosen for the coursework. May be used in calculating the overall grade. Read-only.

Parameters:

gradeCategory - gradeCategory or null for none

getId

public String getId()

Classroom-assigned identifier of this course work, unique per course. Read-only.

Returns:

value or null for none

setId

public CourseWork setId(String id)

Classroom-assigned identifier of this course work, unique per course. Read-only.

Parameters:

id - id or null for none

getIndividualStudentsOptions

public IndividualStudentsOptions getIndividualStudentsOptions()

Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework.

Returns:

value or null for none

setIndividualStudentsOptions

public CourseWork setIndividualStudentsOptions(IndividualStudentsOptions individualStudentsOptions)

Identifiers of students with access to the coursework. This field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`. If the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students specified in this field are assigned the coursework.

Parameters:

individualStudentsOptions - individualStudentsOptions or null for none

getMaterials

public List<Material> getMaterials()

Additional materials. CourseWork must have no more than 20 material items.

Returns:

value or null for none

setMaterials

public CourseWork setMaterials(List<Material> materials)

Additional materials. CourseWork must have no more than 20 material items.

Parameters:

materials - materials or null for none

getMaxPoints

public Double getMaxPoints()

Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.

Returns:

value or null for none

setMaxPoints

public CourseWork setMaxPoints(Double maxPoints)

Maximum grade for this course work. If zero or unspecified, this assignment is considered ungraded. This must be a non-negative integer value.

Parameters:

maxPoints - maxPoints or null for none

getMultipleChoiceQuestion

public MultipleChoiceQuestion getMultipleChoiceQuestion()

Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.

Returns:

value or null for none

setMultipleChoiceQuestion

public CourseWork setMultipleChoiceQuestion(MultipleChoiceQuestion multipleChoiceQuestion)

Multiple choice question details. For read operations, this field is populated only when `work_type` is `MULTIPLE_CHOICE_QUESTION`. For write operations, this field must be specified when creating course work with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be set otherwise.

Parameters:

multipleChoiceQuestion - multipleChoiceQuestion or null for none

getScheduledTime

public String getScheduledTime()

Optional timestamp when this course work is scheduled to be published.

Returns:

value or null for none

setScheduledTime

public CourseWork setScheduledTime(String scheduledTime)

Optional timestamp when this course work is scheduled to be published.

Parameters:

scheduledTime - scheduledTime or null for none

getState

public String getState()

Status of this course work. If unspecified, the default state is `DRAFT`.

Returns:

value or null for none

setState

public CourseWork setState(String state)

Status of this course work. If unspecified, the default state is `DRAFT`.

Parameters:

state - state or null for none

getSubmissionModificationMode

public String getSubmissionModificationMode()

Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.

Returns:

value or null for none

setSubmissionModificationMode

public CourseWork setSubmissionModificationMode(String submissionModificationMode)

Setting to determine when students are allowed to modify submissions. If unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.

Parameters:

submissionModificationMode - submissionModificationMode or null for none

getTitle

public String getTitle()

Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.

Returns:

value or null for none

setTitle

public CourseWork setTitle(String title)

Title of this course work. The title must be a valid UTF-8 string containing between 1 and 3000 characters.

Parameters:

title - title or null for none

getTopicId

public String getTopicId()

Identifier for the topic that this coursework is associated with. Must match an existing topic in the course.

Returns:

value or null for none

setTopicId

public CourseWork setTopicId(String topicId)

Identifier for the topic that this coursework is associated with. Must match an existing topic in the course.

Parameters:

topicId - topicId or null for none

getUpdateTime

public String getUpdateTime()

Timestamp of the most recent change to this course work. Read-only.

Returns:

value or null for none

setUpdateTime

public CourseWork setUpdateTime(String updateTime)

Timestamp of the most recent change to this course work. Read-only.

Parameters:

updateTime - updateTime or null for none

getWorkType

public String getWorkType()

Type of this course work. The type is set when the course work is created and cannot be changed.

Returns:

value or null for none

setWorkType

public CourseWork setWorkType(String workType)

Type of this course work. The type is set when the course work is created and cannot be changed.

Parameters:

workType - workType or null for none

set

public CourseWork set(String fieldName,
                      Object value)

Overrides:

set in class GenericJson

clone

public CourseWork clone()

Overrides:

clone in class GenericJson