CLASS CustomFolder

This class requires no license. It uses standard functions and actions to perform CustomFolder related operations

Class Field Properties

Name	Codename	Description	Ability	Length
curpriv	CurrentPrivs	Current Privileges	RO	255
path	path	Path	RO	255
parent	parent	Parent	RO	255
access	Access	Access	RO	255
depth	depth	Depth	RO	255
shortname	ShortName	Short Name	RO	255

Class Functions

Name	Description
static cancel	CustomFolder.cancel() takes no arguments. User must have cancel privileges. This standard function removes any pending edits on the object. Used with CustomFolder.get(name).
static close	CustomFolder.close() takes no arguments.
static connect	CustomFolder.connect() takes no arguments.
static create	CustomFolder.create() takes no arguments.
static delete	CustomFolder.delete() takes no arguments.
static ExclusiveConnect	CustomFolder.ExclusiveConnect() takes no arguments.
static exists	CustomFolder.exists() takes no arguments.
static get	CustomFolder.get(name) takes an argument, name. This standard function gets and returns the named CustomFolder object. If the object name exists, it returns the object name. If the object name does not exist, it throws an exception.
static getCount	CustomFolder.getCount() takes no arguments. This standard function gets the number of defined CustomFolder resources.
static getFetchLevel	CustomFolder.getFetchLevel() takes no arguments.
static getList	CustomFolder.getList() takes no arguments. This standard function gets and returns an arrary (list) of CustomFolder resources.
static getLog	CustomFolder.getLog() takes no arguments.
static getLogCalendar	CustomFolder.getLogCalendar() takes no arguments.
static getNames	CustomFolder.getNames() takes no arguments. This standard function gets and returns an array of strings object with the CustomFolder names.
static getRange	CustomFolder.getRange() takes no arguments.
static getUsage	CustomFolder.getUsage() takes no arguments.
static isConnected	CustomFolder.isConnected() takes no arguments.
static isNew	isNew() takes no arguments and returns a boolean value. This standard function checks for object existence, to create or update when save is called. The function returns true if the object does not exist on the server and will create one when save() is called. It returns false if the object exists and will update the object when save() is called.
static log	CustomFolder.log() takes no arguments.
static logScannable	CustomFolder.logScannable() takes no arguments.
static monitor	CustomFolder.monitor() takes no arguments.
static read	CustomFolder.read() takes no arguments.
static refresh	CustomFolder.refresh() takes no arguments.
static save	save() takes no arguments. User must have save privileges. This standard function saves to the server a CustomFolder object and the appropriate logs. This includes any pending edits made on the object. save() throws an exception if validation or save fails.
static setFetchLevel	CustomFolder.setFetchLevel() takes no arguments.
static setOptions	CustomFolder.setOptions() takes 2 arguments.
static Validate	CustomFolder.Validate() takes no arguments.
static write	CustomFolder.write() takes no arguments.

Class Privilege Properties

Type	Name
AWARE	Aware
VIEW	View
CREATE	Add
DELETE	Delete
MODIFY	Edit
IMPORT	Upload File
RENAME	Rename
CREATEZIP	Create Zip
OPENZIP	Open Zip
SETOPTION	Set Options
MAKEAVAILABLE	Make Available
CANCELTRANSFER	Cancel Transfer
MAKEUNAVAILABLE	Make Unavailable

Class Association Properties

Type	Name
tag	CustomFolder to Tag
widgettype	CustomFolder to WidgetType