This class defines the structure for a collection object. A collection holds information about a group of video clips.

Collection contains the following public methods:

Method Description

db_load_by_name() Load a record by ID / Name. Raise a RecordNotFound exception if record is not found in database.

db_load_by_num() Load a record by record number. Raise a RecordNotFound exception if record is not found in database.

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

db_delete() Delete this object record from the database. Raises RecordLockedError exception if the record is locked and unable to be deleted.

GetNodeData() Returns the Node Data list (list of parent collections) needed for Database Tree Manipulation

GetNodeString() Returns a string that delineates the full nested collection structure for the present collection

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_name()`	Load a record by ID / Name. Raise a RecordNotFound exception if record is not found in database.
`db_load_by_num()`	Load a record by record number. Raise a RecordNotFound exception if record is not found in database.
`db_save()`	Save the record to the database using Insert or Update as appropriate.
`db_delete()`	Delete this object record from the database. Raises RecordLockedError exception if the record is locked and unable to be deleted.
`GetNodeData()`	Returns the Node Data list (list of parent collections) needed for Database Tree Manipulation
`GetNodeString()`	Returns a string that delineates the full nested collection structure for the present collection
`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.

Collection contains the following public properties:

Property Description

parent Parent Collection number for nested collections.

parentName Parent Collection Name for nested collections.

owner Person responsible for creating or maintaining the Collection.

keyword_group Default keyword group to be suggested for all new clips.

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
`parent`	Parent Collection number for nested collections.
`parentName`	Parent Collection Name for nested collections.
`owner`	Person responsible for creating or maintaining the Collection.
`keyword_group`	Default keyword group to be suggested for all new clips.
`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).