Tag

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 tag is a piece of arbitrary information which can be attached to many other types of objects. Tags are arranged hierarchically, and each tree of tags has a root node also called a "tag group" The tag group "Subjects" is special and always exists in every onCourse database. The complete path to a tag is unique (that is, siblings cannot have the same tag name).

 
        public 
        Tag
     {
}

Instance methods

attachDocument(doc)

Document doc

the document to be attached to this tag

Returns def

Documentation not yet available

allChildren

The resulting map has the tag name as the key and the tag itself as a value.

Returns Not null Map<String, Tag>

map of children tags

childTags

@see ish.oncourse.server.cayenne.Tag#getAllChildren()

Returns Not null List<Tag>

all the children of this tag

contents

Returns String

the description of the tag (rich text)

createdOn

Returns Date

the date and time this record was created

documents

Returns Not null List<Document>

The list of attached documents

generation

This method returns the 'depth' of the tag For example, calculating the generation on the tag 'Japanese' with the following path would return 2. 'Japanese' has parent 'Languages', which has the parent 'Subjects' Subjects/Languages/Japanese

Returns int

the depth of a tag

isWebVisible

Returns Not null Boolean

true if this tag is visible on the website

modifiedOn

Returns Date

the date and time this record was modified

name

Returns Not null String

the name of the tag

parentTag

Returns Not null Tag

the parent of this tag

pathName

Returns Not null String

full path name for this tag starting from root delimited with "-"

root

Returns Not null Tag

the top-most tag of this tree. Also known as a tag group.

shortName

Tags can have a shorter name which is used in URLs on a website The short name must be unique amongst siblings. If the short name is null, then the long name is used for the URL.

Returns String

the short name

siblings

This method gets all tags with the same parent as the current tag

Returns List<Tag>

siblings of this tag

tagRequirements

Returns Not null List<TagRequirement>

all the requirements for this tag group

weight

A weight is an arbitrary number for determining ordering. The actual value of the weight should be ignored and this value should only be used for sorting.

Returns Integer

weight

isMultipleFor(entity)

Some objects can have multiple tags from the same tag group attached to them. For example, a course may be tagged with both "Finance" and "Computing" subjects.

Class<? extends Taggable> entity

the entity which is being tagged

Returns boolean

true if multiple tags from the same group are allowed

isRequiredFor(entity)

The objects from some entities must be tagged with at least one tag from a certain tag group

Class<? extends Taggable> entity

the entity class which is being tagged

Returns boolean

true if a tag is required from the tag group this tag is part of

isRoot()

Returns boolean

true if this tag is the top of the tree (the tag group)