This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revision | ||
| libtf:documentation:api:persistentobject [2018/02/24 18:45] – lee | libtf:documentation:api:persistentobject [2018/09/24 17:15] (current) – removed lee | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | [[libtf: | ||
| - | |||
| - | |||
| - | ====== LibTF.PersistentObject ====== | ||
| - | |||
| - | Blurb. | ||
| - | |||
| - | |||
| - | ===== Fields ===== | ||
| - | |||
| - | ==== (PersistentObject).id ==== | ||
| - | |||
| - | * Getter: Returns the persistence id of this object. | ||
| - | * Setter: None. | ||
| - | |||
| - | |||
| - | ==== (PersistentObject).parentId ==== | ||
| - | |||
| - | * Getter: Returns the persistence id of this object' | ||
| - | * Setter: None. | ||
| - | |||
| - | |||
| - | ==== (PersistentObject).parent ==== | ||
| - | |||
| - | * Getter: Returns fully instantiated parent of this object. | ||
| - | * Setter: None. | ||
| - | |||
| - | |||
| - | ===== Methods ===== | ||
| - | |||
| - | ==== (PersistentObject).hasPersistent( subid ) ==== | ||
| - | |||
| - | * //subid// is a persistence id fragment referring to some child data record for this object. | ||
| - | * Returns: True if there is a record for the specified child data on this object, or False if there is not. | ||
| - | * Throws: Error if: subid contains invalid characters. | ||
| - | |||
| - | Checks to see if there is child data for the given //subid// available for this object. | ||
| - | |||
| - | //This method is generally only used internally by derived classes. | ||
| - | |||
| - | < | ||
| - | if( tfGet(" | ||
| - | alert( "Joe has a lastName child field!" | ||
| - | </ | ||
| - | |||
| - | |||
| - | ==== (PersistentObject).getPersistent( subid ) ==== | ||
| - | |||
| - | * //subid// is a persistence id fragment referring to some child data record for this object. | ||
| - | * Returns: The specified child data from this object, or null if there is none. | ||
| - | * Throws: Error if: subid contains invalid characters. | ||
| - | |||
| - | Returns the child data for the given //subid// on this object. | ||
| - | |||
| - | //This method is generally only used internally by derived classes. | ||
| - | |||
| - | < | ||
| - | alert( " | ||
| - | </ | ||
| - | |||
| - | |||
| - | ==== (PersistentObject).setPersistent( subid, value ) ==== | ||
| - | |||
| - | * //subid// is a persistence id fragment referring to some child data record for this object. | ||
| - | * //value// is what to set that child data to. | ||
| - | * Returns: Nothing, but that is a bug and it ought to return the previous value. | ||
| - | * Throws: Error if: subid contains invalid characters. | ||
| - | |||
| - | Sets the child data for the given //subid// on this object to //value//. | ||
| - | |||
| - | //This method is generally only used internally by derived classes. | ||
| - | |||
| - | < | ||
| - | tfGet(" | ||
| - | </ | ||
| - | |||
| - | < | ||
| - | this.resetPersistent = function( subid ) | ||
| - | { | ||
| - | if( subid == null ) | ||
| - | throw "Null id!"; | ||
| - | return Persistence.reset( id+" | ||
| - | } | ||
| - | </ | ||
| - | | ||
| - | < | ||
| - | this.getName = function() | ||
| - | { | ||
| - | if( this.hasPersistent(" | ||
| - | return this.getPersistent(" | ||
| - | return null; | ||
| - | } | ||
| - | </ | ||
| - | | ||
| - | < | ||
| - | this.getAName = function() | ||
| - | { | ||
| - | var name = this.getName(); | ||
| - | if( this.getPersistent(" | ||
| - | return name; | ||
| - | if( this.hasPersistent(" | ||
| - | return this.getPersistent(" | ||
| - | switch( name.charAt(0) ) | ||
| - | { | ||
| - | case ' | ||
| - | case ' | ||
| - | case ' | ||
| - | case ' | ||
| - | case ' | ||
| - | return "an " + name; | ||
| - | default: | ||
| - | return "a " + name; | ||
| - | } | ||
| - | } | ||
| - | </ | ||
| - | |||
| - | [[libtf: | ||