CLASS UserFile
This class requires no license but requires user privileges. It uses only standard functions to perform on UserFile related operations.
Class Functions
| Name | Description |
|---|---|
| static add | UserFile.add(name) takes an argument, UserFile name. The UserFile name can be explicit or checked for existence then retrieved with UserFile.getNames(). User must have create privileges. UserFile.add() creates a named UserFile object. |
| static cancel | cancel() takes no arguments. User must have cancel privileges. This standard function removes any pending edits on the object. Used with UserFile.get(name). |
| static close | UserFile.close() takes no arguments. |
| static connect | UserFile.connect() takes no arguments. |
| static create | UserFile.create() takes no arguments. |
| static delete | UserFile.delete() takes no arguments. |
| static ExclusiveConnect | UserFile.ExclusiveConnect() takes no arguments. |
| static exists | UserFile.exists() takes no arguments. |
| static get | UserFile.get(name) takes an argument, name. This standard function gets and returns the named UserFile object. If the object name exists, it returns the object name. If the object name does not exist, it throws an exception. |
| static getCount | UserFile.getCount() takes no arguments. This standard function gets the number of defined UserFile resources. |
| static getFetchLevel | UserFile.getFetchLevel() takes no arguments. |
| static getList | UserFile.getList() takes no arguments. This standard function gets and returns an arrary (list) of UserFile resources. |
| static getLog | UserFile.getLog() takes no arguments. |
| static getLogCalendar | UserFile.getLogCalendar() takes no arguments. |
| static getNames | UserFile.getNames() takes no arguments. This standard function gets and returns an array of strings object with the UserFile names. |
| static getRange | UserFile.getRange() takes no arguments. |
| static getUsage | UserFile.getUsage() takes no arguments. |
| static isConnected | UserFile.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 | UserFile.log() takes no arguments. |
| static logScannable | UserFile.logScannable() takes no arguments. |
| static monitor | UserFile.monitor() takes no arguments. |
| static read | UserFile.read() takes no arguments. |
| static refresh | UserFile.refresh() takes no arguments. |
| static save | save() takes no arguments. User must have save privileges. This standard function saves to the server a UserFile 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 | UserFile.setFetchLevel() takes no arguments. |
| static update | UserFile.update() takes no arguments. |
| static write | UserFile.write() takes no arguments. |
Class Privilege Properties
| Type | Name |
|---|---|
| CREATE | Add |
| DELETE | Delete |
| VIEW | View |
| MODIFY | Edit |
| AWARE | Aware |