Enrolment

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

An enrolment joins a student to a class. There can be only one enrolment per student per class. An enrolment doesn't directly carry any financial information about the cost of the enrolment, however it might be linked to one or more invoice lines which you can interrogate to determine the cost, discounts and follow through to the invoice and payments. The join between InvoiceLine and Enrolment is one of the few places in onCourse where financial data touches educational data. This is a quite deliberate delineation between the two. An enrolment also doesn't carry information about attendance; there is an Attendance object which joins the Enrolment to each Session in the CourseClass. If you are looking for Outcomes for each unit of competency (Module) undertaken by the Student, then of course follow the relation to Outcomes for this Enrolment.

 
        public 
        Enrolment
     {
}

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

allowedToPrint()

Returns boolean

true if this enrolment will be printed

attachDocument(doc)

Document doc

the document to be attached to this enrolment

Returns def

Documentation not yet available

customField(fieldName)

Retrieves specific custom field value for this enrolment.

String fieldName

name or key of the custom field

Returns Nullable String

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

attendancePercent

Will return null if the class is self paced

Returns def

percent Attendance

attendanceType

Returns Not null CourseClassAttendanceType

standard AttendanceTypes used for AVETMISS reporting in Victoria only

attendances

Returns List<IAttendance>

related attendance list

confirmationStatus

Returns Not null ConfirmationStatus

enrolment confirmation email status: not sent, sent or suppressed from sending

courseClass

Returns Not null CourseClass

linked class record

courseModules

Returns List<Module>

all modules belongs to the course this enrolment belongs to

createdOn

Returns Date

the date and time this record was created

creditFOEId

Returns String

Documentation not yet available

creditLevel

Returns CreditLevel

highest level of prior VET study

creditOfferedValue

Returns String

Documentation not yet available

creditProvider

Returns String

Documentation not yet available

creditProviderType

Returns CreditProviderType

Documentation not yet available

creditTotal

Returns RecognitionOfPriorLearningIndicator

Documentation not yet available

creditType

Returns CreditType

details of prior study for which credit/RPL was offered

creditUsedValue

Returns String

Documentation not yet available

cricosConfirmation

Returns Nullable String

Documentation not yet available

documents

Returns Not null List<Document>

The list of attached documents

eligibilityExemptionIndicator

Returns Not null Boolean

Documentation not yet available

feeHelpAmount

Returns Not null Money

Documentation not yet available

feeHelpStatus

Returns EnrolmentVETFeeHelpStatus

the VET Fee help status for this enrolment

feeStatus

Returns StudentStatusForUnitOfStudy

code indicating student status

fundingSource

Returns ClassFundingSource

standard fundingSource values for AVETMISS reporting

id

Returns Not null Long

The primary key for this record. This value will never change once the record is created.

modifiedOn

Returns Date

the date and time this record was modified

originalInvoiceLine

Such invoice line store original enrolment price, discount amount and other properties which usually uses by customers in reports, exports and other components.

Returns InvoiceLine

original invoice line which was created during enrolment process.

originalInvoiceLine

Such invoice line store original enrolment price, discount amount and other properties which usually uses by customers in reports, exports and other components.

Returns def

original invoice line which was created during enrolment process.

outcomes

Non-VET classes will still have a single outcome for each enrolment, even though that outcome isn't linked to a Module. VET classes may have one or many outcomes. These outcomes are initially attached to the enrolment by creating one Outcome for each Module attached to the Course. However a user may remove and attach other Modules by creating or deleting Outcomes for this specific Enrolment.

Returns Not null List<Outcome>

a list of outcomes

source

Payment can be made in onCourse (office) or from the onCourse website (web).

Returns Not null PaymentSource

where the payment for this enrolment was made

status

Returns EnrolmentStatus

origin of this enrolment: website or onCourse

student

Returns Not null Student

the student who enrolled

studentIndustryANZSICCode

Returns Integer

ANZSIC standard code for industrial classification

studyReason

Returns Not null StudyReason

standard set of values for AVETMISS reporting

suppressAvetmissExport

Returns Boolean

true if enrolment is suppressed from appearing in AVETMISS export

surveys

Returns Not null List<Survey>

all survey results for this enrolment

tags

Get all tags related to this object.

Returns List<Tag>

List of related tags

trainingPlanDeveloped

Returns Boolean

Documentation not yet available

vetClientID

Returns String

Documentation not yet available

vetFeeExemptionType

Returns VETFeeExemptionType

value for AVETMISS reporting

vetFeeIndicator

Returns Not null Boolean

Documentation not yet available

vetFundingSourceStateID

An AVETMISS reporting requirement for the VET Funding source state ID of an enrolment. If the VET Funding source state ID is not overridden in the enrolment, this function will return the value from the class.

Returns String

Documentation not yet available

vetIsFullTime

Returns Not null Boolean

returns true if this is a full time enrolment

vetPurchasingContractID

An AVETMISS reporting requirement for the purchasing contract ID of an enrolment. If the purchasing contract ID is not overridden in the enrolment, this function will return the value from the class.

Returns String

Documentation not yet available

vetTrainingContractID

Returns String

Documentation not yet available

hasAttendance()

Returns boolean

true if related attendances exist for this enrolment

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