Assignment (gradebook-service-api 12.3 API)

java.lang.Object
- org.sakaiproject.service.gradebook.shared.Assignment

All Implemented Interfaces:

Serializable, Comparable<Assignment>
```
public class Assignment
extends Object
implements Serializable, Comparable<Assignment>
```
JavaBean to hold data associated with a Gradebook assignment. The Course Grade is not considered an assignment.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

Assignment()

Constructors
Constructor and Description
`Assignment()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(Assignment o)`
`Integer`	`getCategorizedSortOrder()`
`Long`	`getCategoryId()`
`String`	`getCategoryName()`
`Integer`	`getCategoryOrder()`
`Date`	`getDueDate()`
`String`	`getExternalAppName()`
`String`	`getExternalId()`
`boolean`	`getExtraCredit()`
`Long`	`getId()`
`String`	`getName()`
`Double`	`getPoints()`
`Integer`	`getSortOrder()`
`boolean`	`getUngraded()`
`Double`	`getWeight()`
`boolean`	`isCategoryExtraCredit()`
`boolean`	`isCounted()`
`boolean`	`isExternallyMaintained()`
`boolean`	`isExtraCredit()`
`boolean`	`isReleased()`
`void`	`setCategorizedSortOrder(Integer categorizedSortOrder)`
`void`	`setCategoryExtraCredit(boolean categoryExtraCredit)`
`void`	`setCategoryId(Long categoryId)`
`void`	`setCategoryName(String categoryName)`
`void`	`setCategoryOrder(Integer categoryOrder)`
`void`	`setCounted(boolean notCounted)`
`void`	`setDueDate(Date dueDate)`
`void`	`setExternalAppName(String externalAppName)`
`void`	`setExternalId(String externalId)`
`void`	`setExternallyMaintained(boolean externallyMaintained)`
`void`	`setExtraCredit(boolean extraCredit)`
`void`	`setId(Long id)`
`void`	`setName(String name)`
`void`	`setPoints(Double points)`
`void`	`setReleased(boolean released)`
`void`	`setSortOrder(Integer sortOrder)` Note that any calls setSortOrder will not be persisted.
`void`	`setUngraded(boolean ungraded)`
`void`	`setWeight(Double weight)`
`String`	`toString()`

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

- Constructor Detail
  - Assignment
```
public Assignment()
```
- Method Detail
  - getName
```
public String getName()
```
    Returns:
    
    Returns the name of the assignment. The assignment name is unique among currently defined assignments. However, it is not a safe UID for persistance, since an assignment can be renamed. Also, an assignment can be deleted and a new assignment can be created re-using the old name.
  - getId
```
public Long getId()
```
    Returns:
    
    Returns the ID of the assignment in the gradebook
  - getPoints
```
public Double getPoints()
```
    Returns:
    
    Returns the total points the assignment is worth.
  - getDueDate
```
public Date getDueDate()
```
    Returns:
    
    Returns the due date for the assignment, or null if none is defined.
  - isExternallyMaintained
```
public boolean isExternallyMaintained()
```
    Returns:
    
    Returns true if the assignment is maintained by some software other than the Gradebook itself.
  - isReleased
```
public boolean isReleased()
```
    Returns:
    
    true if the assignment has been released for view to students
  - getExternalAppName
```
public String getExternalAppName()
```
    Returns:
    
    Returns the externalAppName, or null if the assignment is maintained by the Gradebook
  - getExternalId
```
public String getExternalId()
```
    Returns:
    
    Returns the external Id, or null if the assignment is maintained by the Gradebook
  - isCounted
```
public boolean isCounted()
```
  - setCounted
```
public void setCounted(boolean notCounted)
```
  - setPoints
```
public void setPoints(Double points)
```
  - setDueDate
```
public void setDueDate(Date dueDate)
```
  - setExternalAppName
```
public void setExternalAppName(String externalAppName)
```
  - setExternalId
```
public void setExternalId(String externalId)
```
  - setExternallyMaintained
```
public void setExternallyMaintained(boolean externallyMaintained)
```
  - setName
```
public void setName(String name)
```
  - setReleased
```
public void setReleased(boolean released)
```
  - setId
```
public void setId(Long id)
```
  - getCategoryName
```
public String getCategoryName()
```
  - setCategoryName
```
public void setCategoryName(String categoryName)
```
  - getWeight
```
public Double getWeight()
```
  - setWeight
```
public void setWeight(Double weight)
```
  - getUngraded
```
public boolean getUngraded()
```
  - setUngraded
```
public void setUngraded(boolean ungraded)
```
  - setExtraCredit
```
public void setExtraCredit(boolean extraCredit)
```
  - isExtraCredit
```
public boolean isExtraCredit()
```
  - getExtraCredit
```
public boolean getExtraCredit()
```
  - setCategoryExtraCredit
```
public void setCategoryExtraCredit(boolean categoryExtraCredit)
```
  - isCategoryExtraCredit
```
public boolean isCategoryExtraCredit()
```
  - getSortOrder
```
public Integer getSortOrder()
```
  - setSortOrder
```
public void setSortOrder(Integer sortOrder)
```
    Note that any calls setSortOrder will not be persisted. If you want to change the sort order of an assignment you must call GradebookService.updateAssignmentOrder as that method properly handles the reordering of all other assignments for the gradebook.
  - getCategoryId
```
public Long getCategoryId()
```
  - setCategoryId
```
public void setCategoryId(Long categoryId)
```
  - getCategoryOrder
```
public Integer getCategoryOrder()
```
  - setCategoryOrder
```
public void setCategoryOrder(Integer categoryOrder)
```
  - compareTo
```
public int compareTo(Assignment o)
```
    Specified by:
    
    compareTo in interface Comparable<Assignment>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getCategorizedSortOrder
```
public Integer getCategorizedSortOrder()
```
  - setCategorizedSortOrder
```
public void setCategorizedSortOrder(Integer categorizedSortOrder)
```

Class Assignment

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Assignment

Method Detail

getName

getId

getPoints

getDueDate

isExternallyMaintained

isReleased

getExternalAppName

getExternalId

isCounted

setCounted

setPoints

setDueDate

setExternalAppName

setExternalId

setExternallyMaintained

setName

setReleased

setId

getCategoryName

setCategoryName

getWeight

setWeight

getUngraded

setUngraded

setExtraCredit

isExtraCredit

getExtraCredit

setCategoryExtraCredit

isCategoryExtraCredit

getSortOrder

setSortOrder

getCategoryId

setCategoryId

getCategoryOrder

setCategoryOrder

compareTo

toString

getCategorizedSortOrder

setCategorizedSortOrder