Main Page | Packages | Class Tree | Index | Help

xp.util

class LocalSharedObject

Object
  |
  +--xp.util.LocalSharedObject


class LocalSharedObject
extends Object



Field Summary

public
schema: Object
a schema for this object*

public
so: SharedObject
Reference to the LSO that his instance wraps.*

Constructor

public
LocalSharedObject ( name: String, path: String, schema: Object)
Construct a new instanceof a LocalShared Object*

Method Summary

public
addSchemaItem ( name: String, persistant: Boolean, defaultValue: Object )
Add an item to the schema*

public
clear ( ): Void


public
flush ( ): Void


public
getValue ( name: String, defaultValue: Object ): Object
Helper function to protect retrieved values

public
setValue ( name: String, value: Object, persistant: Boolean ): Void
Helper function to set values



Field Documentation

schema

public var schema: Object
a schema for this object*

so

public var so: SharedObject
Reference to the LSO that his instance wraps.*


Constructor Documentation

LocalSharedObject

public function LocalSharedObject(name: String,
 path: String,
 schema: Object)
Construct a new instanceof a LocalShared Object*


Method Documentation

addSchemaItem

public function addSchemaItem(name: String,
 persistant: Boolean,
 defaultValue: Object)
Add an item to the schema*

clear

public function clear(): Void

flush

public function flush(): Void

getValue

public function getValue(name: String,
 defaultValue: Object): Object
Helper function to protect retrieved values

returns a value or if null returns the default value

Parameters:
name
val the value
defaultValue
defautlValue The default value to use if val is null
Returns:
a value

setValue

public function setValue(name: String,
 value: Object,
 persistant: Boolean): Void
Helper function to set values

set a value in the local shared object

Parameters:
name
the name of the property to store
value
the value
persistant
Is the value persistant

The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc