QualityResultSpec

Contents

General
CloudAssessSpec
CollegePreferenceService
CsvBuilder
DocumentService
DocumentSpec
EmailSpec
ExportSpec
MailchimpSpec
Mask
Money
Preferences
QualityResultSpec
ReportSpec
SmsSpec
SystemUserService
Database objects
ACLAccessKey
ACLRole
Account
AccountTransaction
Application
Article
ArticleProduct
Assessment
AssessmentClass
AssessmentSubmission
AttachmentData
Attendance
Banking
Certificate
ClassCost
ConcessionType
Contact
ContactRelation
ContactRelationType
CorporatePass
CorporatePassCourseClass
CorporatePassProduct
Country
Course
CourseClass
CourseClassTutor
CourseModule
CustomField
CustomFieldType
DefinedTutorRole
Discount
DiscountConcessionType
DiscountCourseClass
DiscountMembership
DiscountMembershipRelationType
Document
DocumentVersion
EmailTemplate
Enrolment
EntityRelation
ExportTemplate
Field
FieldConfiguration
FieldConfigurationScheme
FieldHeading
FundingSource
FundingUpload
FundingUploadOutcome
Import
Invoice
InvoiceDueDate
InvoiceLine
InvoiceLineDiscount
Language
Membership
MembershipProduct
Message
MessagePerson
Module
Note
Outcome
PayLine
PayRate
PaymentIn
PaymentInLine
PaymentMethod
PaymentOut
PaymentOutLine
Payslip
Preference
PriorLearning
Product
ProductItem
Qualification
Report
ReportOverlay
Room
SavedFind
Script
Session
SessionModule
Site
Student
StudentConcession
Survey
SystemUser
Tag
TagRelation
TagRequirement
Tax
TrainingPackage
Tutor
TutorAttendance
UnavailableRule
Voucher
VoucherPaymentIn
VoucherProduct
WaitingList
Enumerations
AccountTransactionType
AccountType
ApplicationStatus
AttachmentInfoVisibility
AttachmentSpecialType
AttendanceType
AvetmissStudentDisabilityType
AvetmissStudentEnglishProficiency
AvetmissStudentIndigenousStatus
AvetmissStudentLabourStatus
AvetmissStudentPriorEducation
AvetmissStudentSchoolLevel
ClassCostFlowType
ClassCostRepetitionType
ClassFundingSource
ClientIndustryEmploymentType
ClientOccupationIdentifierType
ConfirmationStatus
ContactDuplicateStatus
CourseClassAttendanceType
CourseEnrolmentType
CreditCardType
CreditLevel
CreditProviderType
CreditType
DeliveryMode
DeliverySchedule
DiscountType
EnrolmentStatus
EnrolmentVETFeeHelpStatus
EntityRelationType
ExpiryType
FieldConfigurationType
InvoiceType
KeyCode
KeyCollision
MessageStatus
MessageType
MoneyRounding
NodeSpecialType
OutcomeStatus
PaymentSource
PaymentStatus
PaymentType
PayslipStatus
PostcodeType
ProductStatus
ProductType
QualificationType
RecognitionOfPriorLearningIndicator
StudentCitizenship
StudentStatusForUnitOfStudy
StudyReason
SurveyTypeSource
SurveyVisibility
TriggerType
UsiStatus
VETFeeExemptionType
VoucherPaymentStatus

QualityResult building API. Usage example:

result {
  message "${enrolmentsToFix.size()} outcomes have completed more than 7 days ago and don't yet have a result entered"
  records enrolmentsToFix
  severity Severity.WARNING
}

or if you don't want to specify records, the message will be associated with the entity in general

result {
  message "You have not yet created any sites."
  entity "Site"
  severity Severity.WARNING
}

 
        public 
        QualityResultSpec
     {
}

Instance methods

entity(entity)

If the rule doesn't specify certain records which need fixing, then just pass the entity name. This is not very common.

String entity

the case sensitive name of the entity as text

message(markupBuilder)

Sets result HTML message using MarkupBuilder object passed to it. E.g.

message builder.html {
	p("${enrolmentsToFix.size()} outcomes have completed more than 7 days ago and don't yet have a result entered")
}

Typically you don't need to specify html in the message unless you have particular styling you need to apply.

MarkupBuilder markupBuilder

a helper class for creating XML or HTML markup

message(message)

Sets plain text result message. Make this short enough to display in a small user interface widget and alert the user to the problem they need to rectify

String message

Plain text message

records(recordsToFix)

If this rule defines particular records to fix, then pass them here. Those records will have the message you created shown in the user interface against each record.

List recordsToFix

list of records need to be fixed

severity(severity)

For granular severity levels you can pass an integer here. This allows you to carefully prioritise different rules against each other.

int severity

an integer between 0 (lowest severity) and 100 (most severe)

severity(severity)

If you just want to use one of the built-in severity levels, then this will do the trick. Severity constants correspond to colouring in the UI.

Severity severity

a severity constant