CLASS ConsoleToScript

This class requires no license. It includes the provision of a component referenece to a list of resources in the Console component (class). ConsoleToScript uses only standard functions.

Class Field Properties

Name	Codename	Description	Ability	Length
console	Console	Console	RO	255

Class Functions

Name	Description
static add	ConsoleToScript.add(name) takes an argument, ConsoleToScript name. The ConsoleToScript name can be explicit or checked for existence then retrieved with ConsoleToScript.getNames(). User must have create privileges. ConsoleToScript.add() creates a named ConsoleToScript object.
static cancel	cancel() takes no arguments. User must have cancel privileges. This standard function removes any pending edits on the object. Used with ConsoleToScript.get(name).
static close	ConsoleToScript.close() takes no arguments.
static connect	ConsoleToScript.connect() takes no arguments.
static create	ConsoleToScript.create() takes no arguments.
static delete	ConsoleToScript.delete() takes no arguments.
static ExclusiveConnect	ConsoleToScript.ExclusiveConnect() takes no arguments.
static exists	ConsoleToScript.exists() takes no arguments.
static get	ConsoleToScript.get(name) takes an argument, name. This standard function gets and returns the named ConsoleToScript object. If the object name exists, it returns the object name. If the object name does not exist, it throws an exception.
static getCount	ConsoleToScript.getCount() takes no arguments. This standard function gets and returns the number of defined ConsoleToScript resources.
static getFetchLevel	ConsoleToScript.getFetchLevel() takes no arguments.
static getList	ConsoleToScript.getList() takes no arguments. This standard function gets and returns an arrary (list) of ConsoleToScript resources.
static getLog	ConsoleToScript.getLog() takes no arguments.
static getLogCalendar	ConsoleToScript.getLogCalendar() takes no arguments.
static getNames	ConsoleToScript.getNames() takes no arguments. This standard function gets and returns an array of strings object with the ConsoleToScript names.
static getRange	ConsoleToScript.getRange() takes no arguments.
static getUsage	ConsoleToScript.getUsage() takes no arguments.
static isConnected	ConsoleToScript.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	ConsoleToScript.log() takes no arguments.
static logScannable	ConsoleToScript.logScannable() takes no arguments.
static monitor	ConsoleToScript.monitor() takes no arguments.
static read	ConsoleToScript.read() takes no arguments.
static refresh	ConsoleToScript.refresh() takes no arguments.
static save	save() takes no arguments. User must have save privileges. This standard function saves to the server a ConsoleToScript 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	ConsoleToScript.setFetchLevel() takes no arguments.
static update	ConsoleToScript.update() takes no arguments.
static write	ConsoleToScript.write() takes no arguments.

Class Privilege Properties

Type	Name
CREATE	Add
DELETE	Delete
VIEW	View
MODIFY	Edit
AWARE	Aware