CLASS Example

This class requires no license. It uses standard functions, actions, and associations to perform on Example related operations.

This class does not allow log transforms.

Class Field Properties

Name	Codename	Description	Ability	Length
curpriv	CurrentPrivs	Current Privileges	RO	255
created	Created	Created	RO	255
created_by	CreatedBy	Created By	RO	255
updated	Updated	Updated	RO	255
updated_by	UpdatedBy	Updated By	RO	255
loaded	Loaded	Loaded	RO	255
outofdate	OutOfDate	Out of Date	RO	255
isedited	IsEdited	Is Edited	RO	255
versionwarn	VersionWarn	Version Warning	RO	15
loaddisabled	LoadDisabled	Load Disabled	RO	255
wasautolded	WasAutoLoaded	Was AutoLoaded	RO	255

Class Functions

Name	Description
static add	Example.add(name) takes an argument, Example name. The Example name can be explicit or checked for existence then retrieved with Example.getNames(). User must have create privileges. Example.add() creates a named Example object.
static AutoLoad	Example.AutoLoad() takes no arguments.
static cancel	Example.cancel() takes no arguments. User must have cancel privileges. This standard function removes any pending edits on the object. Used with Example.get(name).
static CheckUpdate	CheckUpdate() takes no arguments. This action determines whether updates to example scripts are available.
static ClearAutoLoaded	Example.ClearAutoLoaded() takes no arguments.
static close	Example.close() takes no arguments.
static connect	Example.connect() takes no arguments.
static create	Example.create() takes no arguments.
static delete	Example.delete() takes no arguments.
static ExclusiveConnect	Example.ExclusiveConnect() takes no arguments.
static exists	Example.exists() takes no arguments.
static get	Example.get(name) takes an argument, name. This standard function gets and returns the named Example object. If the object name exists, it returns the object name. If the object name does not exist, it throws an exception.
static getCount	Example.getCount() takes no arguments. This standard function gets the number of defined Example resources.
static getFetchLevel	Example.getFetchLevel() takes no arguments.
static getList	Example.getList() takes no arguments. This standard function gets and returns an arrary (list) of Example resources.
static getLog	Example.getLog() takes no arguments.
static getLogCalendar	Example.getLogCalendar() takes no arguments.
static getNames	Example.getNames() takes no arguments. It gets and returns an array of strings object with the Example names.
static getRange	Example.getRange() takes no arguments.
static getUsage	Example.getUsage() takes no arguments.
static Instructions	Instructions() takes no arguments. It opens the instructions for a specified CWScript example.
static isConnected	Example.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 LibUpdate	Example.LibUpdate() takes 2 arguments.
static Load	Load() takes no arguments. It loads a specifiec CWScript example into a ConsoleWorks function.
static log	Example.log() takes no arguments.
static logScannable	Example.logScannable() takes no arguments.
static monitor	Example.monitor() takes no arguments.
static PreLoad	PreLoad() takes no arguments. It prepares a CWScript example for loading into a specified CWScript example.
static Publish	Publish() takes no arguments. This action publishes uploaded CWSript example files to the ConsoleWorks serer. Used with Example.get(name).
static read	Example.read() takes no arguments.
static Reference	Reference() takes no arguments. This action allows access to the Reference data. Used with Example.get(name).
static refresh	Example.refresh() takes no arguments.
static Rename	Rename(newname) takes one argument, the new name of the Example object. User must have rename and Example privileges. Used with Example.getName(name).
static save	save() takes no arguments. User must have save privileges. This standard function saves to the server a Example 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	Example.setFetchLevel() takes no arguments.
static Unlink	Unlink() takes no arguments. It removes the link to a specifiec CWScript example.
static update	Example.update() takes no arguments.
static write	Example.write() takes no arguments.

Class Privilege Properties

Type	Name
AWARE	Aware
VIEW	View
CREATE	Add
DELETE	Delete
MODIFY	Edit
RENAME	Rename
UNLINK	Unlink
LOAD	Load
EXAUPDATE	Library Update
PUBLISH	Publish Library

Class Association Properties

Type	Name
category	Example to Category
exampledep	Example to Dependency
exmplrelated	Example to Related