Engine for Web Applications

static org.cote.js

version 1.9.18

Utilities for javascript objects.

This class participates in the engine library.

Index

Example Index

• New Object: Create a new JavaScript object that conforms to the Engine for Web Applications API.
• Object Prototype: This example shows the prototype of an object created with newInstance or modified with prepareObject, and identifies the properties and methods that are created.
• Prepare Existing Object: Prepare an existing JavaScript object for use with Engine for Web Applications.

Property Index

• private class_imports: Merge definitions.
• public object_version: Version of this object.

Method Index

• private _forName (internal): Creates a specific internal object.
• private _get_gunid (internal): Returns a locally unique id.
• private _implements: Implements a specified feature.
• public gnbid: Returns a low impact unique id.
• public guid: Returns a unique id.
• public hashlight: Returns a simple hash of the specified value
• private merge: Merges an internal object into the specified.
• public newObject: Creates and optionally registers a new object ready for use within the Engine for Web Applications framework. The new object, like most other framework objects, implements base_object and exposes the following methods: getObjectVersion, getObjectType, getObjectId, getReadyState, getPointers, and getStatus. This method invokes prepareObject, so there is no need to invoke both newObject and then invoke prepareObject.
• public prepareObject: Prepares and optionally registers a new object ready for use within the Engine for Web Applications framework. The new object, like most other framework objects, implements base_object and exposes the following methods: getObjectVersion, getObjectType, getObjectId, getReadyState, getPointers, and getStatus.

Examples

New Object

• Top
• js
• Examples

Create a new JavaScript object that conforms to the Engine for Web Applications API.

Example Code

// Don't automatically add to registry
var oNewObject = org.cote.js.newObject("DemoType","1.0", false);
// Manually add new object to registry
org.cote.js.registry.ObjectRegistry.addObject(oNewObject);
// Automatically add to registry
var oNewObject2 = org.cote.js.newObject("DemoType","1.0",true);

Object Prototype

• Top
• js
• Examples

This example shows the prototype of an object created with newInstance or modified with prepareObject, and identifies the properties and methods that are created.

Example Code

var oObject = {
   object_type:"specified",
   object_id:"guid",
   ready_state:0,
   object_config:{
      pointers:{
      },
      status:{
      }
   },
   getObjectId:function(){return this.object_id;},
   getObjectType:function(){return this.object_type;},
   getObjectVersion:function(){return this.object_version;},
   getReadyState:function(){return this.ready_state;},
   getStatus:function(){return this.object_config.status;},
   getPointers:function(){return this.object_config.pointers;}
}

Prepare Existing Object

• Top
• js
• Examples

Prepare an existing JavaScript object for use with Engine for Web Applications.

Example Code

function MyObject(){
   this.custom_property = "some value";
}
MyObject.prototype.CustomFunction = function(){
};
var oObject = new MyObject();
org.cote.js.prepareObject("DemoType","1.0",true,oObject);

Properties

class_imports

• Top
• js
• Properties

Merge definitions. Property is private and should not be directly referenced.

Syntax

array = org.cote.js.class_imports

object_version

• Top
• js
• Properties

Version of this object.

Syntax

String = org.cote.js.object_version

Methods

_forName

• Top
• js
• Methods

Creates a specific internal object. Method is private and should not be directly referenced.

Syntax

o = _forName( s )

Parameters

• s as String : Name of the object to return.

Returns

o as object: Object based on the specified name.

_get_gunid

• Top
• js
• Methods

Returns a locally unique id. Method is private and should not be directly referenced.

Syntax

i = _get_gunid( )

Returns

i as String: A locally unique id.

_implements

• Top
• js
• Methods

Implements a specified feature. Method is private and should not be directly referenced.

Syntax

void _implements( o, n, v )

Parameters

• o as object : Target object to merge features..
• n as String : Name of merge features.
• v as variant : Overloaded variant arguments to pass to the implementing object constructor.

gnbid

• Top
• js
• Methods

Returns a low impact unique id.

Syntax

i = gnbid( )

Returns

i as String: A simplified unique id.

guid

• Top
• js
• Methods

Returns a unique id.

Syntax

i = guid( )

Returns

i as String: A unique id.

hashlight

• Top
• js
• Methods

Returns a simple hash of the specified value

Syntax

h = hashlight( s )

Parameters

• s as String : Low impact hash function.

Returns

h as String: A hash of the specified value.

merge

• Top
• js
• Methods

Merges an internal object into the specified. Method is private and should not be directly referenced.

Syntax

h = merge( o, n, s )

Parameters

• o as object : Target object to merge features..
• n as String : Name of merge features.
• s as String : String representing merge features.

Returns

h as String: A hash of the specified value.

newObject

• Top
• js
• Methods

Creates and optionally registers a new object ready for use within the Engine for Web Applications framework. The new object, like most other framework objects, implements base_object and exposes the following methods: getObjectVersion, getObjectType, getObjectId, getReadyState, getPointers, and getStatus. This method invokes prepareObject, so there is no need to invoke both newObject and then invoke prepareObject.

Syntax

o = newObject( t, v, r )

Parameters

• t as String : The type of the object.
• v as String : The version of the object.
• r as boolean : Bit indicating whether the object should be registered with the Object Registry.

Returns

o as object: The new framework object.

prepareObject

• Top
• js
• Methods

Prepares and optionally registers a new object ready for use within the Engine for Web Applications framework. The new object, like most other framework objects, implements base_object and exposes the following methods: getObjectVersion, getObjectType, getObjectId, getReadyState, getPointers, and getStatus.

Syntax

void prepareObject( t, v, r, o )

Parameters

• t as String : The type of the object.
• v as String : The version of the object.
• r as boolean : Bit indicating whether the object should be registered with the Object Registry.
• o as object : The object to be prepared for use in the Engine for Web Applications framework.