CourseClass

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

The CourseClass entity is what you see in the user interface called just "class". The term 'CourseClass' is used because 'class' is a reserved word in Java and will cause ambiguity. A CourseClass is the object which can be enrolled in by students, has a price, timetable and represents the instance of the Course which is sold and delivered.

 
        public 
        CourseClass
     {
}

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 the CourseClass record

Returns def

Documentation not yet available

actualCustomInvoices

Returns def

Documentation not yet available

actualDiscounts

Returns def

Documentation not yet available

actualFeeIncome

Returns def

Documentation not yet available

actualOtherIncome

Returns def

Documentation not yet available

actualTotalCost

Returns def

Documentation not yet available

actualTotalIncome

Returns def

Documentation not yet available

actualTotalProfit

Returns def

Documentation not yet available

attendance

An alias for getAttendance(true)

Returns def

attendance lines for this particular courseClass including tutors

getAttendance(addTutorLines)

boolean addTutorLines

Documentation not yet available

Returns List<PrintableAttendance>

attendance lines for this particular courseClass

attendanceType

Returns Not null CourseClassAttendanceType

AttendanceType for AVETMISS reporting in Victoria only

attendanceWithoutTutor

An alias for getAttendance(false)

Returns def

attendance lines for this particular courseClass excluding tutors

budgetedCustomInvoices

Returns def

Documentation not yet available

budgetedDiscounts

Returns def

Documentation not yet available

budgetedFeeIncome

Returns def

Documentation not yet available

budgetedOtherIncome

Returns def

Documentation not yet available

budgetedPlaces

Returns Not null Integer

number of budgeted places

budgetedTotalCost

Returns def

Documentation not yet available

budgetedTotalIncome

Returns def

Documentation not yet available

budgetedTotalProfit

Returns def

Documentation not yet available

category

Returns the first child of the 'Subject' tag of the course this courseClass belongs to Subject/[Languages]/Japanese

Returns def

the name of the Subject child tag applied to this CourseClass

censusDate

Returns LocalDate

the census date for NCVER reporting

classTotalFeeIncomeExTaxForRefundedAndCancelledEnrolments

Returns def

all enrolments with a CANCELLED or REFUNDED status

code

Returns Not null String

class code

corporatePassCourseClass

Returns all CorperatePasses that can be used with this CourseClass

Returns Not null List<CorporatePassCourseClass>

object relating class and CorporatePass

costs

Returns Not null List<ClassCost>

all ClassCosts linked to this CourseClass

course

Returns Not null Course

course record linked to this class

createdOn

Returns Date

the date and time this record was created

deliveryMode

Returns Not null DeliveryMode

standard deliveryMode value for AVETMISS reporting

deposit

Returns Money

Documentation not yet available

description

Returns Not null String

description for this class containing its course name and venue where it is held

detBookingId

DET Booking ID are used for NSW ePayments AVETMISS reporting.

Returns String

standard DET Booking ID string

discountCourseClasses

Returns all Discount that can be used with this CourseClass

Returns Not null List<DiscountCourseClass>

object relating class and Discounts

discountedInvoiceLinesForEnrolments

Collects all successful enrolments attached to this courseClass used a discount

Returns def

InvoiceLines sorted by discount name

discounts

This is a faked flattened relationship via discountCourseClasses.discount.

Returns Not null List<Discount>

the discounts for this class

discountsDescription

Returns a string with the format "discount.name discount.description discount.feeExGst" for all discounts attached to this CourseClass

Returns def

Documentation not yet available

displayableLocation

Returns Not null String

a string representation of the site name, street, suburb, and postcode.

documents

Returns Not null List<Document>

The list of attached documents

endDateTime

Returns Date

end date and time of the last session of the class

enrolments

Returns Not null List<Enrolment>

complete list of enrolments (successful, failed or cancelled) ever made to this class

enrolmentsCount

Returns def

Integer number of successful enrolments in this CourseClass

enrolmentsToProceed

Get number of enrolments for class to cover its running costs.

Returns def

required number of enrolments

enrolmentsToProfit

Get number of enrolments for class to be profitable.

Returns def

required number of enrolments

getEnrolmentsWithinDateRange(from, to)

Get number of enrolments for class created in a given date range

Date from

start Date range

Date to

end Date range

Returns def

number of enrolments created within the given range

expectedHours

Returns BigDecimal

Documentation not yet available

feeExGst

Returns Not null Money

the class free exclusing GST

feeGST

Returns Money

the GST of the class fee

feeHelpClass

Returns Not null Boolean

Documentation not yet available

feeIncGst

Returns Money

class fee including GST

finalDETexport

Returns String

Documentation not yet available

firstRoom

Returns def

the Room associated with the first session of the class

firstSession

Convenience method to get the very first (chronologically) session for a class

Returns Nullable Session

first session (in chronological order)

firstSubjectTag

Returns def

the first child of the Subject tag applied to this class

fullFeeEnrolments

Returns def

all enrolments that did not use a discount

fullFeeEnrolmentsFeesSum

Returns def

the sum of all enrolment fees for all enrolments that did not use a discount

fullTimeLoad

Returns String

Documentation not yet available

fundingSource

Returns Not null ClassFundingSource

Documentation not yet available

incomeAccount

Returns Not null Account

Documentation not yet available

initialDETexport

Returns String

Documentation not yet available

invoiceLines

Returns Not null List<InvoiceLine>

Documentation not yet available

isActive

Returns Not null Boolean

true if class is active and can accept enrolments

isCancelled

Returns Not null Boolean

true if class has been cancelled

isClassFeeApplicationOnly

Returns Not null Boolean

Documentation not yet available

isDistantLearningCourse

Returns Not null Boolean

Documentation not yet available

isShownOnWeb

Returns Not null Boolean

true if class is visible and searchable on college website

manuallyDiscountedEnrolments

Returns def

all enrolments in this courseClass enrolled with a manual discount

maxStudentAge

Returns Integer

the maximum age of students allowed to enrol in this courseClass

maximumDays

Returns Integer

Documentation not yet available

maximumPlaces

Returns Not null Integer

maximum number of enrolments class can accept

maximumTotalCost

Returns def

Documentation not yet available

maximumTotalIncome

Returns def

Documentation not yet available

maximumTotalProfit

Returns def

Documentation not yet available

message

Returns String

Documentation not yet available

midwayDETexport

Returns String

Documentation not yet available

minStudentAge

Returns Integer

the minimum age of students allowed to enrol in this courseClass

minimumPlaces

Returns Not null Integer

minimim number of enrolments required for class to proceed

minutesPerSession

Returns Integer

duration of the session in minutes

modifiedOn

Returns Date

the date and time this record was modified

nominalHours

Returns def

Documentation not yet available

notes

Returns String

concatenated notes

outcomes

Returns def

all outcomes of all enrolments in this courseCLass

payableClassroomHours

Returns BigDecimal

sum of payable hours in all sessions of this courseClass

getPercentageOfDeliveredScheduledHoursBeforeDate(treshold)

Convenience method to get the percentage of delivered hours

Date treshold

- date to calculate the ratio

Returns BigDecimal

percentage of delivered hours

placesLeft

Returns def

number of enrolments left before reaching the maxiumum number of enrolments in the courseClass

getPrepaidFeesForMonth(monthsCount)

int monthsCount

Documentation not yet available

Returns def

Documentation not yet available

publicRelativeURL

Returns Not null String

/class/uniqueCode

refundedAndCancelledEnrolments

Returns def

Documentation not yet available

reportableHours

Returns BigDecimal

Documentation not yet available

reportableHourse

Returns def

Documentation not yet available

reportingPeriod

Returns Integer

Documentation not yet available

room

Returns Not null Room

main room associated with this class

sessionModules

Returns def

Documentation not yet available

sessionRepeatInterval

Returns Integer

Documentation not yet available

sessionRepeatType

Returns SessionRepetitionType

Documentation not yet available

sessions

Returns Not null List<Session>

list of sessions linked to this class

sessionsCount

Returns Not null Integer

number of sessions class has

getSessionsCountForTutor(t)

Tutor t

Documentation not yet available

Returns int

Documentation not yet available

sessionsSkipWeekends

Returns Boolean

Documentation not yet available

startDateTime

Returns Date

start date and time of the first session of the class

studentContactHours

Returns def

Documentation not yet available

subcategory

Returns the first child of the 'Subject' tag of the course this courseClass belongs to Subject/Languages/[Japanese]

Returns def

the name of the 2nd Subject child tag applied to this CourseClass

successAndQueuedEnrolments

Returns Not null List<Enrolment>

list of successful and in transaction enrolments made to this class

suppressAvetmissExport

Returns Not null Boolean

true if this class is suppressed from AVETMISS export

tags

Returns Not null List<Tag>

The list of tags assigned to course class

tags

Get all tags related to this object.

Returns List<Tag>

List of related tags

taxAdjustment

Returns Not null Money

Documentation not yet available

timeZone

Returns TimeZone

time zone of the class venue or default server time zone if not specified

timetableSummary

Returns def

Documentation not yet available

totalIncomeAmount

Returns def

Documentation not yet available

totalIncomeAmountWithoutPrepaidFees

Returns def

Documentation not yet available

tutorConfirmedDate

Returns Date

Documentation not yet available

tutorNames

Returns def

Documentation not yet available

tutorNamesAbriged

Returns def

Documentation not yet available

tutorRoles

Returns the a list of TutorRole objects that is used to relate CourseClasses and Tutors

Returns Not null List<CourseClassTutor>

relation TutorRole object of each Tutor assigned to this class

uniqueCode

Returns Not null String

a unique identifier in the form {@code courseCode-classCode}.

uniqueSessionModules

Returns def

Documentation not yet available

validEnrolmentCount

Returns int

number of successful and in transaction enrolments made to this class

getValueForKey(key)

String key

Documentation not yet available

Returns Object

Documentation not yet available

vetCourseSiteID

Returns Integer

Documentation not yet available

vetFundingSourceStateID

Returns String

Documentation not yet available

vetPurchasingContractID

Returns String

Documentation not yet available

vetPurchasingContractScheduleID

Returns String

Documentation not yet available

webDescription

Returns String

web description field that is rendered on courseClass webpage

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

isActual()

Checks if CourseClass isn't finished and isn't cancelled in the moment of method call

Returns def

Documentation not yet available

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