Function Class_PropertyTenants
Gets a object of data about Tenants for a Property
Class_PropertyTenants([PROPCODE],[GETMETHOD])Parameters
| # | Type | Passing | Default | Name | Description/Comments | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | string | required | Blank | PROPCODE | The property code to get Tenant data for | ||||||||||||||
| 2 | integer | optional | System Default | GETMETHOD | Method to use to get data
|
Returns
A Property Tenant Object
Examples
{{Local m.poTenants}}
{{m.poTenants = Class_PropertyTenants(PROPCODE,0)}}
{{m.poTenants.getdata()}} Will get the data and store it in a variable for later use
{{o.set("poTenants",Class_PropertyTenants(PROPCODE,0))}}
{{m.o.poTenants.getdata()}} Will get the data and store it in the o variable as poTenants for later use
Example use
{{m.o.poTenants = Class_PropertyTenants(PROPCODE,0)}}
{{m.o.poTenants.getdata()}}
{{IF m.poTenants.numberoftenants>0}}
{{ENDIF}}
{{IF m.poTenants.numberoftenants>1}}
{{ENDIF}}
{{IF m.poTenants.numberoftenants>2}}
{{ENDIF}}
{{IF m.poTenants.numberoftenants>3}}
{{ENDIF}}
The Tenant: [[m.poTenants.tenants[1].clcodedesc]] of [[m.poTenants.tenants[1].address]] The Tenant: [[m.poTenants.tenants[2].clcodedesc]] of [[m.poTenants.tenants[2].address]] The Tenant: [[m.poTenants.tenants[3].clcodedesc]] of [[m.poTenants.tenants[3].address]] The Tenant: [[m.poTenants.tenants[4].clcodedesc]] of [[m.poTenants.tenants[4].address]]
Method Calls Available
| Name | Returns | Passing | Default | Description/Comments |
|---|---|---|---|---|
| GetEmailAddressList | string | Separator Character | | | Returns a list of unique email addresses from Tenants |
| GetExpressionList | string | Separator Character Expression String - fields referenced must be prefixed CLIENT. | | "" | Returns the unique evaluated expression for each Tenant. Each item except the last with be seperated by the seperator |
| GetExpressionListAll | string | Separator Character Expression String - fields referenced must be prefixed CLIENT. | | "" | Returns the evaluated expression for each Tenant. Each item except the last with be seperated by the seperator |
Examples
m.poTenants.GetEmailAddressList(", ") m.poTenants.GetExpressionList(", ","alltrim(CLIENT.FNAME)+' '+alltrim(CLIENT.SNAME)") 
