Module completion statistics for the current user's primary organisation, the organisation that the user's primary membership belongs to, optionally scoped to a single program, course or module. Instances are built with a constructor matching the scope required, from no scope at all up to a specific module, and are typically obtained from a ProgramFolder, CourseFolder or ModuleFolder via getOrgModuleStats. The module lists are computed on first access and cached on the instance for the rest of its lifetime.
Properties
| Property | Returns | Description |
|---|---|---|
| completedModules | List<ModuleStatus> | The module status records for the current user within this organisation and scope that are complete. Computed on first access and cached for the lifetime of this instance. |
| modules | List<ModuleStatus> | All module status records for the current user within this organisation and scope, both started and completed. Computed on first access and cached for the lifetime of this instance. |
Methods
getModules()
Returns: List<ModuleStatus>
All module status records for the current user within this organisation and scope, both started and completed. Computed on first access and cached for the lifetime of this instance.
getCompletedModules()
Returns: List<ModuleStatus>
The module status records for the current user within this organisation and scope that are complete. Computed on first access and cached for the lifetime of this instance.
getCompletedModulesByUser(String name)
Returns: List<ModuleStatus>
Filters the completed module statuses in this organisation and scope down to those belonging to the team member with the given profile name.
| Parameter | Description |
|---|---|
name | the profile name of the team member to filter by |
getModulesByUser(String name)
Returns: List<ModuleStatus>
Filters the module statuses in this organisation and scope down to those belonging to the team member with the given profile name, whether started or completed.
| Parameter | Description |
|---|---|
name | the profile name of the team member to filter by |