| ACTIONAFTERCREATETRANSFEREVENT |
| rc - function actionAfterCreateTransferEvent |
Arguments:
| Name |
Required |
Type |
Default |
| event |
Required |
transfer.com.events.TransferEvent |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Observer action method for when creates occur |
| Description: |
|
|
|
| ACTIONAFTERDELETETRANSFEREVENT |
| rc - function actionAfterDeleteTransferEvent |
Arguments:
| Name |
Required |
Type |
Default |
| event |
Required |
transfer.com.events.TransferEvent |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Observer action method for when deletes occur |
| Description: |
|
|
|
| ACTIONAFTERDISCARDTRANSFEREVENT |
| rc - function actionAfterDiscardTransferEvent |
Arguments:
| Name |
Required |
Type |
Default |
| event |
Required |
transfer.com.events.TransferEvent |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Observer action method for when discards occur |
| Description: |
|
|
|
| ACTIONAFTERUPDATETRANSFEREVENT |
| rc - function actionAfterUpdateTransferEvent |
Arguments:
| Name |
Required |
Type |
Default |
| event |
Required |
transfer.com.events.TransferEvent |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Observer method action for when updates occur |
| Description: |
|
|
|
| CLONE |
| rc - function clone |
| Arguments: | none |
| ReturnType: |
transfer.com.TransferObject
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Get a deep clone of this object |
| Description: |
|
|
|
| COPYVALUESTO |
| rc - function copyValuesTo |
Arguments:
| Name |
Required |
Type |
Default |
| transfer |
Required |
transfer.com.TransferObject |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Copies the values of this object to one of the same class |
| Description: |
|
|
|
| CREATETRANSFEROBJECT |
| rc - function createTransferObject |
Arguments:
| Name |
Required |
Type |
Default |
| className |
Required |
string |
|
| key |
Required |
any |
|
| memento |
Required |
struct |
|
|
| ReturnType: |
transfer.com.TransferObject
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
popultes a new transfer object and returns it |
| Description: |
|
|
|
| EQUALSTRANSFER |
| rc - function equalsTransfer |
Arguments:
| Name |
Required |
Type |
Default |
| transfer |
Required |
transfer.com.TransferObject |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
If an object is persisted, returns true if they are of the same class and same id. If not, returns true if they are the same object. |
| Description: |
|
|
|
| GETADDRESS1 |
| rc - function getaddress1 |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Accessor for property address1 |
| Description: |
|
|
|
| GETADDRESS1ISNULL |
| rc - function getaddress1IsNull |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns whether or not address1's value matches the set NULL value' |
| Description: |
|
|
|
| GETADDRESS2 |
| rc - function getaddress2 |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Accessor for property address2 |
| Description: |
|
|
|
| GETADDRESS2ISNULL |
| rc - function getaddress2IsNull |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns whether or not address2's value matches the set NULL value' |
| Description: |
|
|
|
| GETCITY |
| rc - function getcity |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Accessor for property city |
| Description: |
|
|
|
| GETCITYISNULL |
| rc - function getcityIsNull |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns whether or not city's value matches the set NULL value' |
| Description: |
|
|
|
| GETCLASSNAME |
| rc - function getClassName |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
The class name of the TransferObject |
| Description: |
|
|
|
| GETCOMPANYNAME |
| rc - function getcompanyName |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Accessor for property companyName |
| Description: |
|
|
|
| GETCOMPOSITE |
| rc - function getComposite |
Arguments:
| Name |
Required |
Type |
Default |
| className |
Required |
string |
|
| memento |
Required |
struct |
|
| primarykey |
Required |
string |
|
|
| ReturnType: |
TransferObject
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
retrieves or builds the requisite composite from the memento |
| Description: |
|
|
|
| GETEMAIL |
| rc - function getemail |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Accessor for property email |
| Description: |
|
|
|
| GETFIRSTNAME |
| rc - function getfirstName |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Accessor for property firstName |
| Description: |
|
|
|
| GETID |
| rc - function getid |
| Arguments: | none |
| ReturnType: |
uuid
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Accessor for property id |
| Description: |
|
|
|
| GETISCLONE |
| rc - function getIsClone |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
If this object is a clone or not |
| Description: |
|
|
|
| GETISDIRTY |
| rc - function getIsDirty |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
If this object's data is differnt from that stored in the DB. |
| Description: |
|
|
|
| GETISLOADED |
| rc - function getIsLoaded |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
easy way to determine if the data is loaded, since this is a TransferObject, it must be loaded, and therefore returns true. |
| Description: |
|
|
|
| GETISPERSISTED |
| rc - function getIsPersisted |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
If this object is stored in the database |
| Description: |
|
|
|
| GETISPROXY |
| rc - function getIsProxy |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
returns whether or not this is a proxy object. Since this is a TrasferObject, it returns false. |
| Description: |
|
|
|
| GETLASTNAME |
| rc - function getlastName |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Accessor for property lastName |
| Description: |
|
|
|
| GETLOADED |
| rc - function getLoaded |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETLOADEDOBJECT |
| rc - function getLoadedObject |
| Arguments: | none |
| ReturnType: |
transfer.com.TransferObject
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns itself, as there is no object to load |
| Description: |
|
|
|
| GETMEMENTO |
| rc - function getMemento |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns the memento for all non-lazy members of this object |
| Description: |
|
|
|
| GETNULLABLE |
| rc - function getNullable |
| Arguments: | none |
| ReturnType: |
transfer.com.sql.Nullable
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETORIGINALTRANSFEROBJECT |
| rc - function getOriginalTransferObject |
| Arguments: | none |
| ReturnType: |
transfer.com.TransferObject
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns this object |
| Description: |
|
|
|
| GETPASSWORD |
| rc - function getpassword |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Accessor for property password |
| Description: |
|
|
|
| GETPOSTNUMBER |
| rc - function getpostNumber |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Accessor for property postNumber |
| Description: |
|
|
|
| GETPOSTNUMBERISNULL |
| rc - function getpostNumberIsNull |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Returns whether or not postNumber's value matches the set NULL value' |
| Description: |
|
|
|
| GETPROPERTYMEMENTO |
| rc - function getPropertyMemento |
| Arguments: | none |
| ReturnType: |
struct
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
returns the memento for properties |
| Description: |
|
|
|
| GETSUBDOMAIN |
| rc - function getsubdomain |
| Arguments: | none |
| ReturnType: |
string
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Accessor for property subdomain |
| Description: |
|
|
|
| GETSYSTEM |
| rc - function getSystem |
| Arguments: | none |
| ReturnType: |
any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETTHISOBJECT |
| rc - function getThisObject |
| Arguments: | none |
| ReturnType: |
transfer.com.TransferObject
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| GETTRANSFER |
| rc - function getTransfer |
| Arguments: | none |
| ReturnType: |
Transfer
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Transfer for creation of composite objects |
| Description: |
|
|
|
| GETUTILITY |
| rc - function getUtility |
| Arguments: | none |
| ReturnType: |
transfer.com.util.Utility
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| INIT |
| rc - function init |
Arguments:
| Name |
Required |
Type |
Default |
| transfer |
Required |
transfer.com.Transfer |
|
| utility |
Required |
transfer.com.util.Utility |
|
| nullable |
Required |
transfer.com.sql.Nullable |
|
| thisObject |
Required |
transfer.com.TransferObject |
|
|
| ReturnType: |
transfer.com.TransferObject
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Constructor for Transfer class time.Domain |
| Description: |
|
|
|
| SAMETRANSFER |
| rc - function sameTransfer |
Arguments:
| Name |
Required |
Type |
Default |
| transfer |
Required |
transfer.com.TransferObject |
|
|
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Checks to see if 2 transfer objects are the same |
| Description: |
|
|
|
| SETADDRESS1 |
| rc - function setaddress1 |
Arguments:
| Name |
Required |
Type |
Default |
| address1 |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Mutator for property address1 |
| Description: |
|
|
|
| SETADDRESS1NULL |
| rc - function setaddress1Null |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set address1 to its NULL value' |
| Description: |
|
|
|
| SETADDRESS2 |
| rc - function setaddress2 |
Arguments:
| Name |
Required |
Type |
Default |
| address2 |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Mutator for property address2 |
| Description: |
|
|
|
| SETADDRESS2NULL |
| rc - function setaddress2Null |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set address2 to its NULL value' |
| Description: |
|
|
|
| SETCITY |
| rc - function setcity |
Arguments:
| Name |
Required |
Type |
Default |
| city |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Mutator for property city |
| Description: |
|
|
|
| SETCITYNULL |
| rc - function setcityNull |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set city to its NULL value' |
| Description: |
|
|
|
| SETCLASSNAME |
| rc - function setClassName |
Arguments:
| Name |
Required |
Type |
Default |
| ClassName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETCOMPANYNAME |
| rc - function setcompanyName |
Arguments:
| Name |
Required |
Type |
Default |
| companyName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Mutator for property companyName |
| Description: |
|
|
|
| SETEMAIL |
| rc - function setemail |
Arguments:
| Name |
Required |
Type |
Default |
| email |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Mutator for property email |
| Description: |
|
|
|
| SETFIRSTNAME |
| rc - function setfirstName |
Arguments:
| Name |
Required |
Type |
Default |
| firstName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Mutator for property firstName |
| Description: |
|
|
|
| SETID |
| rc - function setid |
Arguments:
| Name |
Required |
Type |
Default |
| id |
Required |
uuid |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Mutator for property id |
| Description: |
|
|
|
| SETISCLONE |
| rc - function setIsClone |
Arguments:
| Name |
Required |
Type |
Default |
| IsClone |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
package |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETISDIRTY |
| rc - function setIsDirty |
Arguments:
| Name |
Required |
Type |
Default |
| IsDirty |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
package |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETISPERSISTED |
| rc - function setIsPersisted |
Arguments:
| Name |
Required |
Type |
Default |
| IsPersisted |
Required |
boolean |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
package |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETLASTNAME |
| rc - function setlastName |
Arguments:
| Name |
Required |
Type |
Default |
| lastName |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Mutator for property lastName |
| Description: |
|
|
|
| SETLOADED |
| rc - function setLoaded |
Arguments:
| Name |
Required |
Type |
Default |
| loaded |
Required |
struct |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETMEMENTO |
| rc - function setMemento |
Arguments:
| Name |
Required |
Type |
Default |
| memento |
Required |
struct |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
set the state of this object from a memento |
| Description: |
|
|
|
| SETNULLABLE |
| rc - function setNullable |
Arguments:
| Name |
Required |
Type |
Default |
| Nullable |
Required |
transfer.com.sql.Nullable |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETPASSWORD |
| rc - function setpassword |
Arguments:
| Name |
Required |
Type |
Default |
| password |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Mutator for property password |
| Description: |
|
|
|
| SETPOSTNUMBER |
| rc - function setpostNumber |
Arguments:
| Name |
Required |
Type |
Default |
| postNumber |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Mutator for property postNumber |
| Description: |
|
|
|
| SETPOSTNUMBERNULL |
| rc - function setpostNumberNull |
| Arguments: | none |
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Set postNumber to its NULL value' |
| Description: |
|
|
|
| SETPROPERTYMEMENTO |
| rc - function setPropertyMemento |
Arguments:
| Name |
Required |
Type |
Default |
| memento |
Required |
struct |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
set the Property state of this object with a memento |
| Description: |
|
|
|
| SETSUBDOMAIN |
| rc - function setsubdomain |
Arguments:
| Name |
Required |
Type |
Default |
| subdomain |
Required |
string |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
public |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Mutator for property subdomain |
| Description: |
|
|
|
| SETSYSTEM |
| rc - function setSystem |
Arguments:
| Name |
Required |
Type |
Default |
| System |
Required |
any |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETTHISOBJECT |
| rc - function setThisObject |
Arguments:
| Name |
Required |
Type |
Default |
| thisObject |
Required |
transfer.com.TransferObject |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETTRANSFER |
| rc - function setTransfer |
Arguments:
| Name |
Required |
Type |
Default |
| Transfer |
Required |
Transfer |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| SETUTILITY |
| rc - function setUtility |
Arguments:
| Name |
Required |
Type |
Default |
| Utility |
Required |
transfer.com.util.Utility |
|
|
| ReturnType: |
void
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
|
| Description: |
|
|
|
| THROW |
| rc - function throw |
Arguments:
| Name |
Required |
Type |
Default |
| type |
Required |
string |
|
| message |
Required |
string |
|
| detail |
Optional |
string |
[empty string] |
|
| ReturnType: |
Any
|
| Roles: |
|
| Access: |
private |
| Output: |
false |
| DisplayName: |
|
| Hint: |
Throws an Exception |
| Description: |
|
|
|
| VALIDATECACHESTATE |
| rc - function validateCacheState |
| Arguments: | none |
| ReturnType: |
boolean
|
| Roles: |
|
| Access: |
package |
| Output: |
false |
| DisplayName: |
|
| Hint: |
if this object is cached, then validate that all it's composites are cached too |
| Description: |
|
|
|