CategoryDefinition (gradebook-service-api 22.1 API)

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

All Implemented Interfaces:

Serializable
```
public class CategoryDefinition
extends Object
implements Serializable
```
Provides information describing a gradebook category that may be useful to consumers of the shared gradebook services. Not persisted.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static Comparator<CategoryDefinition> orderComparator

Constructor Summary

Constructors
Constructor Description

CategoryDefinition()

CategoryDefinition(Long id, String name)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Double`	`getPointsForCategory()`
`Double`	`getTotalPoints()`	Helper method to get the total points associated with a category
`boolean`	`isAssignmentInThisCategory(String assignmentId)`
`String`	`toString()`

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

Field Detail

orderComparator

public static Comparator<CategoryDefinition> orderComparator

Constructor Detail

CategoryDefinition
```
public CategoryDefinition()
```

CategoryDefinition

public CategoryDefinition(Long id,
                          String name)

Method Detail
- toString
```
public String toString()
```
  Overrides:
  
  toString in class Object
- getTotalPoints
```
public Double getTotalPoints()
```
  Helper method to get the total points associated with a category
  
  Returns:
  
  the sum of all assignment totals associated with this category
- isAssignmentInThisCategory
```
public boolean isAssignmentInThisCategory(String assignmentId)
```
- getPointsForCategory
```
public Double getPointsForCategory()
```