This class defines the structure for a note object. A note object holds a note that can be attached to various objects.

Note contains the following public methods:

Method Description

db_load_by_num() Load a record by record number.

db_load_by_name() Load a Note by Note ID and the Series, Episode, Collection, Clip, or Transcript number the Note belongs to. Record numbers are passed for one of the parameters after Note ID. Example: db_load_by_name("My note", Collection=1)

db_save() Save the record to the database using Insert or Update as appropriate.

db_delete() Delete this object record from the database.

lock_record() Lock a record. If the lock is unable to be obtained, a RecordLockedError exception is raised with the username of the lock holder passed.

unlock_record() Unlock a record.

duplicate() Return a copy of the object with only the record number changed.

get_note_nums() Get a list of Note numbers that belong to this Object.

get_episode_nums() Get a list of Episode numbers that belong to this Series.

clear() Clear all properties, resetting them to default values.

Method	Description
`db_load_by_num()`	Load a record by record number.
`db_load_by_name()`	Load a Note by Note ID and the Series, Episode, Collection, Clip, or Transcript number the Note belongs to. Record numbers are passed for one of the parameters after Note ID. Example: db_load_by_name("My note", Collection=1)
`db_save()`	Save the record to the database using Insert or Update as appropriate.
`db_delete()`	Delete this object record from the database.
`lock_record()`	Lock a record. If the lock is unable to be obtained, a RecordLockedError exception is raised with the username of the lock holder passed.
`unlock_record()`	Unlock a record.
`duplicate()`	Return a copy of the object with only the record number changed.
`get_note_nums()`	Get a list of Note numbers that belong to this Object.
`get_episode_nums()`	Get a list of Episode numbers that belong to this Series.
`clear()`	Clear all properties, resetting them to default values.

Note contains the following public properties:

Property Description

series_num Series number attached to (if applicable)

episode_num Episode number attached to (if applicable)

collection_num Collection number to which the note belongs.

clip_num Clip number attached to (if applicable)

transcript_num Number of the transcript from which this Note was taken.

notetype Type of Note (read-only)

author Person responsible for creating the Note.

text Text of the note, stored in the database as a BLOB.

comment Description of the Object.

id ID or Name (required).

isLocked Object Is Locked?

lock_time Time of the last record lock (Read only).

number Record number (auto-incremented database field).

record_lock Username of person who has locked the record (Read only).

Property	Description
`series_num`	Series number attached to (if applicable)
`episode_num`	Episode number attached to (if applicable)
`collection_num`	Collection number to which the note belongs.
`clip_num`	Clip number attached to (if applicable)
`transcript_num`	Number of the transcript from which this Note was taken.
`notetype`	Type of Note (read-only)
`author`	Person responsible for creating the Note.
`text`	Text of the note, stored in the database as a BLOB.
`comment`	Description of the Object.
`id`	ID or Name (required).
`isLocked`	Object Is Locked?
`lock_time`	Time of the last record lock (Read only).
`number`	Record number (auto-incremented database field).
`record_lock`	Username of person who has locked the record (Read only).