Contents
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 {
}
The resulting map has the tag name as the key and the tag itself as a value.
@see ish.oncourse.server.cayenne.Tag#getAllChildren()
the description of the tag (rich text)
the date and time this record was created
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
the depth of a tag
true if this tag is visible on the website
the date and time this record was modified
the name of the tag
the parent of this tag
full path name for this tag starting from root delimited with "-"
the top-most tag of this tree. Also known as a tag group.
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.
the short name
This method gets all tags with the same parent as the current tag
all the requirements for this tag group
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.
weight
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.
the entity which is being tagged
true if multiple tags from the same group are allowed
The objects from some entities must be tagged with at least one tag from a certain tag group
the entity class which is being tagged
true if a tag is required from the tag group this tag is part of