Site

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

A Site is a location where training occurs or payments are received (an administrative site). A virtual site can be used for online training. A site has latitude and longitude and directions, and contains one or more rooms in which training is delivered. Even if a site contains only a single room, it is important to create both the site and room.

 
        public 
        Site
     {
}

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 site

Returns def

Documentation not yet available

country

Returns Not null Country

the country of this site

createdOn

Returns Date

the date and time this record was created

documents

Returns Not null List<Document>

The list of attached documents

drivingDirections

Returns String

driving directions for the site (rich text)

isAdministrationCentre

An administration centre is a site which is used for the collection of money. When cash or cheques are receipted, they are linked to a particular administration centre so that banking can be performed separately for each centre.

Returns Not null Boolean

true if this is an admin centre

isShownOnWeb

Returns Not null Boolean

whether this site is visible on the website in the /sites list

isVirtual

Virtual sites are a special online type for delivery of online training. Typically you would have just one of these.

Returns Not null Boolean

true for virtual sites

latitude

Use for directions on your website and allowing students to find classes "near me"

Returns BigDecimal

latitude of this site

localTimezone

Timezones are vital for interpreting the session times for delivery at a particular site. If you deliver in multliple timezones, your website will automatically detect the student timezone and adjust delivery times for online training.

Returns Not null String

the timezone of the site

longitude

Use for directions on your website and allowing students to find classes "near me"

Returns BigDecimal

longitude of this site

modifiedOn

Returns Date

the date and time this record was modified

name

Returns Not null String

the public name for this site.

notes

Returns String

concatenated notes

postcode

Returns String

the postcode of the site

publicTransportDirections

Returns String

public transport directions for the site (rich text)

rooms

A site must have at least one room. Even virtual sites have virtual rooms.

Returns Not null List<Room>

all the rooms located in this site

specialInstructions

Returns String

special instructions are displayed on the website (rich text)

state

Returns String

the state of the site (eg. NSW, VIC, QLD)

street

Returns String

the street address of the site

suburb

Returns String

the suburb of the site

tags

Returns Not null List<Tag>

The list of tags assigned to site

tags

Get all tags related to this object.

Returns List<Tag>

List of related tags

waitingLists

Returns Not null List<WaitingList>

all the waiting list records linked to this site

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