Course

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

Courses are the 'product' students purchase when they enrol. They are enrolled into an instance of a Course, called a CourseClass. The Course carries all the marketing information and is typically what you tag to create a navigation structure on the website. Traineeships are just a special type of course.

 
        public 
        Course
     {
}

Instance methods

addTag(tag)

Add a tag to this object. If the tag requirements don't allow this tag to be added, then this method does nothing and returns false.

Tag tag

the tag you want to add

Returns boolean

true if the tag is found and added

addTag(path)

Add a tag to this object. You need to pass the full path to the tag, for example "Subjects/Arts/Painting". If the tag requirements don't allow this tag to be added, then this method does nothing and returns false.

String path

the full path to the tag

Returns boolean

true if the tag is found and added

attachDocument(doc)

Document doc

the document to be attached to this record

Returns def

Documentation not yet available

customField(fieldName)

Retrieves specific custom field value for this course.

String fieldName

name or key of the custom field

Returns Nullable String

custom field value for current course or null if there is no such custom field

allowWaitingLists

Courses can have waiting lists enabled to allow students to add and remove themselves from a waiting list.

Returns Not null Boolean

true if waiting lists are enabled for this course

applications

Returns Not null List<Application>

application records linked to this course

code

This code must be unique across all courses. It cannot contain spaces or hyphens. Because it is used to generate a URL for the course, it should also be selected for readability, websafe characters and SEO.

Returns Not null String

course code

courseClasses

Returns Not null List<CourseClass>

all courseClasses, whether current, past or future

courseModules

Returns Not null List<CourseModule>

CourseModule records linked to this course

createdOn

Returns Date

the date and time this record was created

currentClassesCount

Returns def

count of current classes for the course

currentlyOffered

Returns Not null Boolean

true if the course is currently advertised

documents

Returns Not null List<Document>

The list of attached documents

enrolmentType

Courses can have classes which are enrolled into directly, or they can be 'course by application' where students apply to the course and then (if accepted) are able to enrol into a class.

Returns Not null CourseEnrolmentType

type of enrolments allowed for this course

enrolments

Returns Not null List<Enrolment>

all enrolments from all classes

fieldConfigurationSchema

Data collection rules allow a course to have a defined {@link FieldConfigurationScheme} which is used to define the data collection form displayed to users at time of enrolment, waiting list or application.

Returns Not null FieldConfigurationScheme

the scheme which applies to this course

fieldOfEducation

Returns String

the NCVER 'Subject field of education' identifer code

isShownOnWeb

Returns Not null Boolean

whether this course is displayed on the website for browsing and searching

isSufficientForQualification

Returns Not null Boolean

true, if students completing this course will be granted a qualification

isTraineeship

Returns Boolean

true if this course is really a traineeship rather than standard course

isVET

Returns Not null Boolean

whether this is a VET course

modifiedOn

Returns Date

the date and time this record was modified

modules

Returns Not null List<Module>

modules linked to this course

name

Note that course names don't need to be the VET official name. It is preferable that they are names appropriate for the best marketing of the course.

Returns Not null String

the human readable name of the course

notes

Returns String

concatenated notes

printedBrochureDescription

Returns String

a shorter plaint text description suitable for a brochure

qualification

Returns Nullable Qualification

qualification linked to this course

reportableHours

If this is a VET course, it might have reportable hours recorded for AVETMISS reporting

Returns BigDecimal

number of reportable hours

sessions

Returns Not null List<Session>

list of sessions linked to this course

tags

Returns Not null List<Tag>

The list of tags assigned to course

tags

Get all tags related to this object.

Returns List<Tag>

List of related tags

voucherProductCourses

Returns Not null List<VoucherProductCourse>

Documentation not yet available

waitingLists

Returns Not null List<WaitingList>

all the waiting list entries for this course

webDescription

The course description is displayed on the course detail page. It can contain rich text for embedding images, blocks, video, dynamic text, and more. It also supported unicode for multi-language support.

Returns String

a rich text field for display on the web

hasTag(path)

Check to see whether this object has this tag. Either pass the name of a tag (for example "Painting") or the full path to the tag, for example "Subjects/Arts/Painting".

String path

the tag name or the full path to the tag

Returns boolean

true if the tag is found and is attached to this object

hasTag(path, isSearchWithChildren)

Check to see whether this object has this tag or it's child tag. Either pass the name of a tag (for example "Painting") or the full path to the tag, for example "Subjects/Arts/Painting".

String path

the tag name or the full path to the tag

boolean isSearchWithChildren

flag to define whether need to find in children tags or not

Returns boolean

true if the tag or it's children is found and is attached to this object

removeTag(tag)

Remove a tag from this object. If the tag isn't already attached, this method does nothing and returns false.

Tag tag

the tag you want to remove

Returns boolean

true if the tag was found and removed

removeTag(path)

Remove a tag from this object. You need to pass the full path to the tag, for example "Subjects/Arts/Painting". If the tag isn't already attached, this method does nothing and returns false.

String path

the full path to the tag

Returns boolean

true if the tag was found and removed