Folder

Description

Folder objects provide a convenient interface for examining folder contents and adding or removing folder items. A Folder object describes a single folder and corresponds to a record in the TS_FOLDERS table. To examine the folder hierarchy or generate the full folder name, use inherited TreeItem methods. To generate a list of items in an folder, see FolderItemList.

Inheritance

AppRecord->TreeItem->Folder

Methods

• AddItem(rec): Add an AppRecord item to this folder.

  Input: rec (AppRecord object) – The item to add to the folder.

  Output: N/A

  Return: (Long Integer) – Non-zero if the item is added successfully; zero if not.

• Contains(tableId, recId): Find out whether the given item is in the current folder.

  Input: tableId (Integer) – Table ID of the item to search for.

  Input: recId (Integer) – TS_ID of the item to search for.

  Output: N/A

  Return: (Long Integer) – Non-zero if this folder contains the item; zero if not.

• DeleteItem(rec): Remove an AppRecord item from this folder. The item is not deleted from the system, just from the folder.

  Input: rec (AppRecord) – The item to remove from this folder.

  Output: N/A

  Return: (Long Integer) – Non-zero if removed successfully; zero if not.