The Gravey Framework and RATS RIA

Class Transaction

Object
   |
   +--GrvObject
         |
         +--Transaction

class Transaction
extends GrvObject


DOMAIN-OBJECT: This class encapsulates a Account "transaction".
Version: 2.0

Author: Bruce Wallace (PolyGlotInc.com)
See:

Defined in rats.js


Constructor Summary
Transaction ()
           
 
Method Summary
 String action()
           return our edit state translated to a broadcast message code
 void addMe()
           mark this transaction as being newly added
 String asUpdateString( <Balance> parentBalance )
           return a string of updates for this transaction formatted as
 "{key}~{action}~{sdate}~{ttype}~{ccode}~{balA}~{balB}~{balC}~{balD}"
 where the fields are defined as follows...
      
 Transaction clone()
           return a clone of this object
 void deleteMe()
           mark this transaction as deleted
 String dump()
           return the debug details of "this"
 void editMe()
           mark this record as having been edited
 String getEditRule( <String> optBalanceID )
           return the edit/validation rule for the specified balance.
 Float getTotal()
           return sum of balances for this transaction
 String getValidity(<String> ID)
           return the validity "code" of the specified attribute
 boolean inactive()
           return whether this transaction needs to update server
 boolean inEdit()
           return whether this transaction has been changed since last save
 boolean isComplex()
           return whether this transaction is a complex type
 boolean isValid()
           return whether this transaction has validated data
 String isViewable()
           return whether this transaction can be viewed if desired
 void konstructor( <String> complexCode, <String> transType, <Float> amountA, <Float> amountB, <Float> amountC, <Float> amountD, <String> editDate, <String> editUser, <int> theKey, <int> optEditStatus )
          
 void setValidity(<String> ID,<String> v)
           set the validity code of the specified attribute
 String state()
           return the formatted version of our edit state
 void undeleteMe()
           restore this transaction to its pre-deleted state
 void uneditMe()
           restore this record to its pre-edited state
 
Methods inherited from class GrvObject
souper
 

Constructor Detail

Transaction

Transaction()

Method Detail

action

String action()

addMe

void addMe()

asUpdateString

String asUpdateString( <Balance> parentBalance )

clone

Transaction clone()

deleteMe

void deleteMe()

dump

String dump()

editMe

void editMe()

getEditRule

String getEditRule( <String> optBalanceID )

getTotal

Float getTotal()

getValidity

String getValidity(<String> ID)

inactive

boolean inactive()

inEdit

boolean inEdit()

isComplex

boolean isComplex()

isValid

boolean isValid()

isViewable

String isViewable()

konstructor

void konstructor( <String> complexCode, <String> transType, <Float> amountA, <Float> amountB, <Float> amountC, <Float> amountD, <String> editDate, <String> editUser, <int> theKey, <int> optEditStatus )

setValidity

void setValidity(<String> ID,<String> v)

state

String state()

undeleteMe

void undeleteMe()

uneditMe

void uneditMe()

The Gravey Framework and RATS RIA

Documentation generated by JSDoc on Thu Jan 6 12:46:18 2011