Function Class_ContractTenants
Gets a object of data about Tenants for a Tenancy
Class_ContractTenants([ALIASFROM])Parameters
| # | Type | Passing | Default | Name | Description/Comments |
|---|---|---|---|---|---|
| 1 | string | optional | Blank | ALIASFROM | The alias to get the data from (CONTRACT table) |
Returns
A Tenancy Tenant Object
Method to Get Data
Class_ContractTenants.getdata([ALIASFROM],[GETMETHOD])Parameters
| # | Type | Passing | Default | Name | Description/Comments | |||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | string | required | alias() | ALIASFROM | The alias to get the data from (CONTRACT table) | |||||||||||||||||||||||||||||||||||||||
| 2 | integer | optional | 0 | GETMETHOD | Method to use to get data
|
Examples
{{Local m.poTenants}}
{{m.poTenants = Class_ContractTenants()}}
{{m.poTenants.getdata(alias(),0)}} Will get the data and store it in a variable for later use as m.poTenants
{{o.set("poTenants",Class_ContractTenants())}}
{{m.o.poTenants.getdata(alias(),0)}} Will get the data and store it in the o variable as poTenants for later use as m.o.poTenants
Example use
{{m.o.poTenants = Class_ContractTenants()}}
{{m.o.poTenants.getdata("CONTRACT",0)}}
{{IF m.o.poTenants.numberoftenants>0}}
{{ENDIF}}
{{IF m.o.poTenants.numberoftenants>1}}
{{ENDIF}}
{{IF m.o.poTenants.numberoftenants>2}}
{{ENDIF}}
{{IF m.o.poTenants.numberoftenants>3}}
{{ENDIF}}
The Tenant: [[m.o.poTenants.tenants[1].clcodedesc]] of [[m.o.poTenants.tenants[1].address]] The Tenant: [[m.o.poTenants.tenants[2].clcodedesc]] of [[m.o.poTenants.tenants[2].address]] The Tenant: [[m.o.poTenants.tenants[3].clcodedesc]] of [[m.o.poTenants.tenants[3].address]] The Tenant: [[m.o.poTenants.tenants[4].clcodedesc]] of [[m.o.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. | None | 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. | None | Returns the evaluated expression for each Tenant. Each item except the last with be seperated by the seperator |
Examples
m.o.poTenants.GetEmailAddressList(";") m.o.poTenants.GetExpressionList(", ","alltrim(CLIENT.FNAME)+' '+alltrim(CLIENT.SNAME)") 
