CollegePreferenceService

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

Service for accessing college preferences.

 
        public 
        CollegePreferenceService
     {
}

Instance methods

get(prefName, defaultValue)

String prefName

name of preference

Object defaultValue

default value

Returns Object

preference value if it is not null, otherwise returns default value

get(prefName)

String prefName

name of preference

Returns Object

preference value if it is not null, otherwise returns empty string.

getPortalCensusUrl(student)

Returns link to USI details entering page in portal crafted for a specific student and valid for 7 days. @deprecated As of onCourse version 8.12, replaced by Student.getPortalLink("USI").

Student student

student whose USI details will be collected

Returns String

link to USI details entering page in portal

getPortalCensusUrl(student, expiryDays)

Returns link to USI details entering page in portal crafted for a specific student and valid for specific number days. @deprecated As of onCourse version 8.12, replaced by Student.getPortalLink("USI", Object timeout).

Student student

student whose USI details will be collected

int expiryDays

is url timeout

Returns String

link to USI details entering page in portal

restrictedPortalURL(path, expiryDays)

Generates signed URL granting access to specific page in portal for a specific number of days. For example following statement restrictedPortalURL("survey/1531", 10) if executed on 1 Jan 2016 will yield the following URL: https://www.skillsoncourse.com.au/portal/survey/1531?valid=20160111&key=k9_S8uk68W5PoCvq5lSUp70sqQY @deprecated As of onCourse version 8.12, replaced by Student.getPortalLink(Object target, Object timeout).

String path

partial portal URL path which will be prepended with 'https://skillsoncourse.com.au/portal'

int expiryDays

number of days after which URL will be expired and no longer valid

Returns String

signed link to specific portal page

restrictedPortalURL(path)

Generates signed URL granting access to specific page in portal for 7 days. For example following statement restrictedPortalURL("survey/1531") if executed on 1 Jan 2016 will yield the following URL: https://www.skillsoncourse.com.au/portal/survey/1531?valid=20160108&key=k9_S8uk68W5PoCvq5lSUp70sqQY @deprecated As of onCourse version 8.12, replaced by Student.getPortalLink(Object target).

String path

partial portal URL path which will be prepended with 'https://skillsoncourse.com.au/portal'

Returns String

signed link to specific portal page