Contents
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 {
}
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.
the tag you want to add
true if the tag is found and added
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.
the full path to the tag
true if the tag is found and added
Retrieves specific custom field value for this course.
Courses can have waiting lists enabled to allow students to add and remove themselves from a waiting list.
true if waiting lists are enabled for this course
application records linked to this course
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.
course code
all courseClasses, whether current, past or future
CourseModule records linked to this course
the date and time this record was created
count of current classes for the course
true if the course is currently advertised
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.
type of enrolments allowed for this course
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.
the scheme which applies to this course
the NCVER 'Subject field of education' identifer code
whether this course is displayed on the website for browsing and searching
true, if students completing this course will be granted a qualification
true if this course is really a traineeship rather than standard course
whether this is a VET course
the date and time this record was modified
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.
the human readable name of the course
concatenated notes
a shorter plaint text description suitable for a brochure
qualification linked to this course
If this is a VET course, it might have reportable hours recorded for AVETMISS reporting
number of reportable hours
Documentation not yet available
all the waiting list entries for this course
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.
a rich text field for display on the web
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".
the tag name or the full path to the tag
true if the tag is found and is attached to this object
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".
the tag name or the full path to the tag
flag to define whether need to find in children tags or not
true if the tag or it's children is found and is attached to this object
Remove a tag from this object. If the tag isn't already attached, this method does nothing and returns false.
the tag you want to remove
true if the tag was found and removed
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.
the full path to the tag
true if the tag was found and removed