Function Class_ContractGuarantors

Function Class_ContractGuarantors

Gets a object of data about Guarantors for a Tenancy

Class_ContractGuarantors([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 Guarantors Object


Method to Get Data

Class_ContractGuarantors.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
GETMETHOD Filter Description
0 ACTIVE AND TENTYPE<=2< /td> Guarantors for all Active Tenants, except Benefit Agency and Permitted Occupiers
1 ACTIVE AND TENTYPE=1 Guarantors for Active Lead Tenant
2 ACTIVE AND TENTYPE=2 Guarantors for all Active Tenants except Lead Tenant, Benefit Agency and Permitted Occupiers
3 ACTIVE AND TENTYPE=3 Guarantors for all Active Benefit Agency
4 ACTIVE AND TENTYPE=4 Guarantors for all Active Permitted Occupiers
-2 ACTIVE AND TENTYPE<>2 Guarantors for all Active Lead Tenant, Benefit Agency and Permitted Occupiers
-3 ACTIVE AND TENTYPE<>3 Guarantors for all Active Tenants and Permitted Occupiers
-4 ACTIVE AND TENTYPE<>4 Guarantors for all Active Tenants and Benefit Agency
10 TENTYPE=1 Guarantors for Lead Tenant (Active or Inactive)
20 TENTYPE=2 Guarantors for all Tenants except Lead Tenant, Benefit Agency and Permitted Occupiers (Active or Inactive)
30 TENTYPE=3 Guarantors for all Benefit Agency (Active or Inactive)
40 TENTYPE=4 Guarantors for all Permitted Occupiers (Active or Inactive)

Examples

{{Local m.poGuarantors}}
{{m.poGuarantors = Class_ContractGuarantors()}}
{{m.poGuarantors.getdata(alias(),0)}}

Will get the data and store it in a variable for later use as m.poGuarantors


{{o.set("poGuarantors",Class_ContractGuarantors())}}
{{m.o.poGuarantors.getdata(alias(),0)}}

Will get the data and store it in the o variable as poGuarantors for later use as m.o.poGuarantors


Example use


{{m.o.poGuarantors = Class_ContractGuarantors()}}
{{m.o.poGuarantors.getdata("CONTRACT",0)}}


{{IF m.o.poGuarantors.numberofguarantors>0}}


{{ENDIF}}

{{IF m.o.poGuarantors.numberofguarantors>1}}


{{ENDIF}}

{{IF m.o.poGuarantors.numberofguarantors>2}}


{{ENDIF}}

{{IF m.o.poGuarantors.numberofguarantors>3}}


{{ENDIF}}
The Tenant: [[m.o.poGuarantors.Guarantors[1].clcodedesc]]
of [[m.o.poGuarantors.Guarantors[1].address]]
The Tenant: [[m.o.poGuarantors.Guarantors[2].clcodedesc]]
of [[m.o.poGuarantors.Guarantors[2].address]]
The Tenant: [[m.o.poGuarantors.Guarantors[3].clcodedesc]]
of [[m.o.poGuarantors.Guarantors[3].address]]
The Tenant: [[m.o.poGuarantors.Guarantors[4].clcodedesc]]
of [[m.o.poGuarantors.Guarantors[4].address]]


Method Calls Available


Name Returns Passing Default Description/Comments
GetEmailAddressList string Separator Character | Returns a list of unique email addresses from Guarantors
GetExpressionList string Separator Character
Expression String - fields referenced must be prefixed CLIENT.
None Returns the unique evaluated expression for each Guarantor.
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 Guarantor.
Each item except the last with be seperated by the seperator

Examples

m.o.poGuarantors.GetEmailAddressList(";")
m.o.poGuarantors.GetExpressionList(", ","alltrim(CLIENT.FNAME)+' '+alltrim(CLIENT.SNAME)")