Room

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 room in a location in which training is delivered. It may be a virtual room (linked to a virtual site) or a physical location. Every site must have at least one room.

 
        public 
        Room
     {
}

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 doucment to be attached to this room

Returns def

Documentation not yet available

courseClasses

Use of this method is discouraged since it can return a very large number of objects. Instead consider a query to find only the records you require.

Returns Not null List<CourseClass>

all courseclasses held or to be held in this room

createdOn

Returns Date

the date and time this record was created

directions

Directions should be relative to the site. That is, a person arrives at the site by public transport or driving and then these directions will get them from the site to the room itself.

Returns String

directions (rich text)

documents

Returns Not null List<Document>

The list of attached documents

facilities

Returns String

facilities available in this room (not usually made public)

modifiedOn

Returns Date

the date and time this record was modified

name

Returns Not null String

The public name for this room. For example "The great hall" or "Room 143"

notes

Returns String

concatenated notes

seatedCapacity

Returns Not null Integer

The number of people this room holds.

sessions

Use of this method is discouraged since it can return a very large number of objects. Instead consider a query to find only the records you require.

Returns Not null List<Session>

all sessions held or to be held in this room

site

Returns Not null Site

The site in which this room is located

tags

Returns Not null List<Tag>

The list of tags assigned to room

tags

Get all tags related to this object.

Returns List<Tag>

List of related tags

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