Records an award of a number of CPD (continuing professional development) training points to a member for completing a module. Each award is tied to the accreditation authority it counts towards, represented by the associated Certificate, and to the ModuleStatus that recorded the completion. The award should be treated as immutable once created; the reqYear, reqMonth and reqDay columns are denormalised copies of the award date kept to make reporting queries cheap.
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| awardDate | Date | The date the points were awarded. Stored as a date only, with no time component. |
| certificate | Certificate | The certificate this award counts towards, which identifies the accreditation authority the points are recognised by. Never null for a persisted award. |
| id | long | The database identifier of this CPD award. |
| modulePath | String | Path of the completed module at the time of the award, formed as the programme code, course code and module code separated by slashes. Stored on the award so reports survive later renames. |
| moduleStatus | ModuleStatus | The module completion record that earned these points, which also identifies the member who earned them. |
| moduleTitle | String | Display title of the completed module as it was when the award was made, kept on the award so reports are unaffected by later edits to the module. |
| numPoints | Double | Number of CPD points granted by this award, as counted towards the associated certificate. |
| reqDay | int | Day of the month of the award date, denormalised onto the row for reporting. One based, from 1 to 31. |
| reqMonth | int | Month of the award date, denormalised onto the row for reporting. Taken straight from java.util.Calendar, so it is zero based: January is 0 and December is 11. |
| reqYear | int | Calendar year of the award date, denormalised onto the row so reports can group by year without a date function. |
| website | Website | The website the module was completed on, which is where the award was earned. |
Methods
getId() · setOrganisation(Organisation organisation) · getWebsite() · setWebsite(Website website) · getCertificate() · setCertificate(Certificate certificate) · getModuleStatus() · setModuleStatus(ModuleStatus moduleStatus) · getModulePath() · setModulePath(String modulePath) · getModuleTitle() · setModuleTitle(String moduleTitle) · getAwardDate() · setAwardDate(Date awardDate) · getNumPoints() · setNumPoints(Double numPoints) · getReqYear() · setReqYear(int reqYear) · getReqMonth() · setReqMonth(int reqMonth) · getReqDay() · setReqDay(int reqDay)
getId()
Returns: long
The database identifier of this CPD award.
setOrganisation(Organisation organisation)
Returns: void
Sets the administrative organisation the award belongs to.
| Parameter | Description |
|---|---|
organisation | the owning organisation |
getWebsite()
Returns: Website
The website the module was completed on, which is where the award was earned.
setWebsite(Website website)
Returns: void
Sets the website the module was completed on.
| Parameter | Description |
|---|---|
website | the website the award was earned on |
getCertificate()
Returns: Certificate
The certificate this award counts towards, which identifies the accreditation authority the points are recognised by. Never null for a persisted award.
setCertificate(Certificate certificate)
Returns: void
Sets the certificate this award counts towards.
| Parameter | Description |
|---|---|
certificate | the certificate the points count towards |
getModuleStatus()
Returns: ModuleStatus
The module completion record that earned these points, which also identifies the member who earned them.
setModuleStatus(ModuleStatus moduleStatus)
Returns: void
Sets the module completion record that earned these points.
| Parameter | Description |
|---|---|
moduleStatus | the module status the award was generated from |
getModulePath()
Returns: String
Path of the completed module at the time of the award, formed as the programme code, course code and module code separated by slashes. Stored on the award so reports survive later renames.
setModulePath(String modulePath)
Returns: void
Sets the path of the completed module.
| Parameter | Description |
|---|---|
modulePath | the module path in programme/course/module form |
getModuleTitle()
Returns: String
Display title of the completed module as it was when the award was made, kept on the award so reports are unaffected by later edits to the module.
setModuleTitle(String moduleTitle)
Returns: void
Sets the display title of the completed module.
| Parameter | Description |
|---|---|
moduleTitle | the module title at the time of the award |
getAwardDate()
Returns: Date
The date the points were awarded. Stored as a date only, with no time component.
setAwardDate(Date awardDate)
Returns: void
Sets the date the points were awarded.
| Parameter | Description |
|---|---|
awardDate | the award date |
getNumPoints()
Returns: Double
Number of CPD points granted by this award, as counted towards the associated certificate.
setNumPoints(Double numPoints)
Returns: void
Sets the number of CPD points granted by this award.
| Parameter | Description |
|---|---|
numPoints | the number of points awarded |
getReqYear()
Returns: int
Calendar year of the award date, denormalised onto the row so reports can group by year without a date function.
setReqYear(int reqYear)
Returns: void
Sets the calendar year of the award date.
| Parameter | Description |
|---|---|
reqYear | the four digit year of the award date |
getReqMonth()
Returns: int
Month of the award date, denormalised onto the row for reporting. Taken straight from java.util.Calendar, so it is zero based: January is 0 and December is 11.
setReqMonth(int reqMonth)
Returns: void
Sets the month of the award date. Expected to be zero based, matching java.util.Calendar.
| Parameter | Description |
|---|---|
reqMonth | the zero based month of the award date |
getReqDay()
Returns: int
Day of the month of the award date, denormalised onto the row for reporting. One based, from 1 to 31.
setReqDay(int reqDay)
Returns: void
Sets the day of the month of the award date.
| Parameter | Description |
|---|---|
reqDay | the day of the month of the award date |