MARINA
Contract Class Reference
Inheritance diagram for Contract:
Inheritance graph

Public Member Functions

_.Library.Status OnBeforeSave (_.Library.Boolean insert)
 If this method is overridden then you must call ..UpdateAudit() yourself.
 
_.Library.Float AccruedPrincipalChargeUnits ()
 How many units of the principal charge have been used by the contract.
 
_.Library.String AllocateContractNumber ()
 Generate a contract number.
 
_.Library.Boolean BillableChargeReset ()
 set the billable amount for all service contract charges for this contract to zero
 
_.Library.Float BillablePrincipalChargeUnits ()
 How many units of the principal charge are billable?
 
_.Library.Status CheckServiceCredit (_.Library.Boolean CheckCredit, _.Library.Boolean StopPoll, _.Library.String new)
 Compares the Contract service Charges, by polling the addresses for meter readings, against the total pre-paid credit. More...
 
_.Library.Status Confirm ()
 Method to call on confirmation of contract. More...
 
_.Library.String CurrentMooring ()
 get the current mooring for a contract
 
_.Library.Status GenerateCredits ()
 Generate Credit Notes for Invoices associated with this contract. More...
 
_.Library.Float GetTotalBillableAmount ()
 The charge due for the outstanding billable units.
 
_.Library.Float GetTotalPrePaid ()
 Total of all pre payment invoices for this contract.
 
_.Library.Float InvoicedAmountGet ()
 Totall amount billed for this contract - take credits into account.
 
_.Library.Integer MaximumNumberOfPayments (_.Library.Date lastpaymentdate)
 Maximum number of phased payments for this contrac - under MDL rules.
 
_.Library.Numeric Phases ()
 returns the number of phases for the contract
 
_.Library.Integer ServicesOnCount (_.Library.String contractid)
 how many services are switched on for this contract
 
 SetCalculatedValues ()
 set the values of fields that are initially calculated
 
_.Library.String UnitPriceDescriptionGet ()
 Description of how the mooring fee unit price was derived.
 

Static Public Member Functions

_.Library.Status AutoCheckOut ()
 Processing Removed!
 
_.Library.String ContractForAddress (_.Library.String addressid)
 Find the current contract for a boat using this Bollard address.
 
_.Library.String CreateContract (ClearWater.Mooring Mooring, ClearWater.Boat Boat, _.Library.Date start, _.Library.Date end, _.Library.String confirmed, _.Library.String ctype)
 Create a new contract and boat in mooring.
 
_.Library.String NextCurrentContract (_.Library.String direction, _.Library.String ipaddress, _.Library.String inberth)
 Called from Next/Previous buttons on the main ClearWater Screen. More...
 

Public Attributes

 AccountBalance
 Calculate the balance of the account for the contract. More...
 
 AccountBalanceReport
 returns numeric vector balance More...
 
 ActualCanxDate
 The day the cancellation was done. More...
 
 AllocatedAmount
   More...
 
 Annulled
   More...
 
 ApplicableTariff
 The mooring tariff for the area in which this boat is. More...
 
 ApplicableTariffDescription
   More...
 
 ApplicableTariffValue
 The mooring tariff for the area in which this boat is. More...
 
 ApplicableTariffVat
 Should be calculated field, not implemented yet. More...
 
 ApplicableTariffVatValue
 Should be calculated field, not implemented yet. More...
 
 ApplicableVatCode
   More...
 
 ApplicableVatCodeValue
   More...
 
 ApplicableVatId
   More...
 
 ApplicableVatIdValue
   More...
 
 ApplicableVatRate
   More...
 
 ApplicableVatRateValue
   More...
 
 Boat
 The boat to which the contract applies. More...
 
 BoatTab
 Transient field for synchronising tabs in vb. More...
 
 CancelCredit
 As part of the cancelling process credit any invoices against. More...
 
 CancellationReason
   More...
 
 Cancelled
 Is the Contract cancelled ? More...
 
 Cancelling
 Set when the user cancels the contract so that when the save. More...
 
 ChargeCount
   More...
 
 CheckIn
   More...
 
 Confirmed
 Is the contract confirmed ? More...
 
 Contacted
 Has the licensee been contated about the confirmation of the. More...
 
 ContractBoatBeam
   More...
 
 ContractBoatLength
   More...
 
 ContractCanxDate
 The effective date of the cancellation. More...
 
 ContractChargeTotal
 The sum of the Contract Charges due for this contract. More...
 
 ContractChargeTotalInclVat
   More...
 
 ContractDescription
   More...
 
 ContractEndDate
   More...
 
 ContractID
   More...
 
 ContractMooring
 Initial mooring for contract. More...
 
 ContractNotes
   More...
 
 ContractNumber
   More...
 
 ContractStartDate
   More...
 
 ContractStartDateInt
   More...
 
 ContractStatus
 The status of the contract. More...
 
 ContractTab
 Transient field for synchronising tabs in VB. More...
 
 ContractType
 ' Temporary/Permanent/... More...
 
 CurrentBerth
 The berth that the boat is currently in as of todays date. More...
 
 DepositAmount
 Calculated deposit. More...
 
 DepositAmountValue
 Calculated deposit. More...
 
 DepositValue
 Deposit value if this is set by the user then it will override the. More...
 
 EffectiveBoatLength
   More...
 
 EffectiveBoatLengthValue
   More...
 
 FirstPrintedDate
   More...
 
 FixedBoatBeam
   More...
 
 FixedBoatLength
   More...
 
 GenerationDate
   More...
 
 Invoiced
 Has an invoice been raised against this contract - includes. More...
 
 InvoicedAmount
   More...
 
 LengthXTariff
   More...
 
 LengthXTariffValue
   More...
 
 LengthXTariffXPeriod
   More...
 
 LengthXTariffXPeriodValue
   More...
 
 Locked
   More...
 
 MaximumNumberOfPayments
   More...
 
 Modified
 Has the contract instance been changed. More...
 
 MooringChargeScheme
 Which charging plan is this contract using. More...
 
 MooringFee
   More...
 
 MooringFeeInclVat
   More...
 
 MooringFeeInclVatValue
   More...
 
 MooringFeeLessDeposit
   More...
 
 MooringFeeValue
   More...
 
 MooringFeeVatAmount
   More...
 
 MooringTab
 Transient property used for synchronising tabs in vb. More...
 
 NewContract
 The contract that was generated based on this one. More...
 
 NumberOfPhasedPayments
 Used in the payment schedule. More...
 
 OldStatus
 if the contract status is changed then update this field More...
 
 PaymentMethod
 How is the contract to be paid. More...
 
 PaymentScheme
 Similar to Payment Type but refined to include 3-part and 8-part Phased. More...
 
 PaymentType
 Deprecated. More...
 
 PerformBalanceTransfer
 has confirmed been set to true? If so then if we transfer More...
 
 PermanentMooring
 Permanent Mooring - This boat may be moved. More...
 
 PhasedContractValue
 Sum of the Scheduled Payments for this contract. More...
 
 PhasedStartMonthOffset
 The month that the first phased payment is due. More...
 
 PhasedStartYear
 The year in which the first phased payment is due. More...
 
 Previewed
 Has the contract document been printed or print previewed. More...
 
 PreviousContract
 The contract on which this contract is based. More...
 
 PrintDocument
   More...
 
 Printed
 Has the contract been printed. More...
 
 ReceiptsTotal
 The total Receipts for a contract inclusive of VAT. More...
 
 Revision
   More...
 
 ServiceBalance
   More...
 
 SpecialRate
 Mooring Fee entered by user which overrides calculated Mooring Fee. More...
 
 TotalExclVat
   More...
 
 TotalExclVatFixed
 The total after the contract has been locked. More...
 
 TotalInclVat
   More...
 
 TotalInclVatFixed
   More...
 
 TotalPaidInAdvance
   More...
 
 TotalVat
   More...
 
 UnitPriceDescription
   More...
 
 ValuesLocked
   More...
 
 WholeAmountPhased
   More...
 
 oldConfirmed
 Database value of the confirmed field. More...
 
- Public Attributes inherited from AuditHistory
 creationDateTime
   More...
 
 creationUserId
   More...
 
 lastChangedDateTime
   More...
 
 lastChangedUserId
   More...
 
 version
   More...
 

Detailed Description

Deltanji status:

ObjectClearWater.Contract.CLS/MARINA.0
ComponentCLS.ClearWater.Contract
LocationMARINA.test2
Date/Time15-May-20 21:21
Userjohnm

Member Function Documentation

◆ CheckServiceCredit()

_.Library.Status CheckServiceCredit ( _.Library.Boolean  CheckCredit,
_.Library.Boolean  StopPoll,
_.Library.String  new 
)

Compares the Contract service Charges, by polling the addresses for meter readings, against the total pre-paid credit.


If none left, it turns off the chargable services. If the CheckCredit flag is false (0), the services are not turned off

StopPoll is used when called from the CurrentServices form in ClearWater The Polling is stopped and then restarted afterwards.

◆ Confirm()

_.Library.Status Confirm ( )

Method to call on confirmation of contract.

If the balance is transferred when the contract is confirmed then perform the transfer

◆ GenerateCredits()

_.Library.Status GenerateCredits ( )

Generate Credit Notes for Invoices associated with this contract.

Also delete any scheduled payments that have not been paid

◆ NextCurrentContract()

_.Library.String NextCurrentContract ( _.Library.String  direction,
_.Library.String  ipaddress,
_.Library.String  inberth 
)
static

Called from Next/Previous buttons on the main ClearWater Screen.

Used to navigate to the next berth with a current boat.

Member Data Documentation

◆ AccountBalance

AccountBalance

Calculate the balance of the account for the contract.

Take into account Invoices/Receipts/refunds/credit notes/

returns a string with DB or CR appended to total  

◆ AccountBalanceReport

AccountBalanceReport

returns numeric vector balance

 

◆ ActualCanxDate

ActualCanxDate

The day the cancellation was done.

 

◆ AllocatedAmount

AllocatedAmount

 

 

◆ Annulled

Annulled

 

 

◆ ApplicableTariff

ApplicableTariff

The mooring tariff for the area in which this boat is.

 

◆ ApplicableTariffDescription

ApplicableTariffDescription

 

 

◆ ApplicableTariffValue

ApplicableTariffValue

The mooring tariff for the area in which this boat is.

 

◆ ApplicableTariffVat

ApplicableTariffVat

Should be calculated field, not implemented yet.

TH 8/5/03  

◆ ApplicableTariffVatValue

ApplicableTariffVatValue

Should be calculated field, not implemented yet.

TH 8/5/03  

◆ ApplicableVatCode

ApplicableVatCode

 

 

◆ ApplicableVatCodeValue

ApplicableVatCodeValue

 

 

◆ ApplicableVatId

ApplicableVatId

 

 

◆ ApplicableVatIdValue

ApplicableVatIdValue

 

 

◆ ApplicableVatRate

ApplicableVatRate

 

 

◆ ApplicableVatRateValue

ApplicableVatRateValue

 

 

◆ Boat

The boat to which the contract applies.

 

◆ BoatTab

BoatTab

Transient field for synchronising tabs in vb.

 

◆ CancelCredit

CancelCredit

As part of the cancelling process credit any invoices against.

this invoice

0 - do nothing 1 - this contract has just been cancelled - so credit any invoices  

◆ CancellationReason

CancellationReason

 

 

◆ Cancelled

Cancelled

Is the Contract cancelled ?

1 cancelled 0 not cancelled  

◆ Cancelling

Cancelling

Set when the user cancels the contract so that when the save.

is being done we know to go and create credit notes for invoices MDL - only  

◆ ChargeCount

ChargeCount

 

 

◆ CheckIn

CheckIn

 

 

◆ Confirmed

Confirmed

Is the contract confirmed ?

1 confirmed 0 not confirmed  

◆ Contacted

Contacted

Has the licensee been contated about the confirmation of the.

contract?

0 no 1 yes

Used for when future contracts are confirmed by default (to show space as used) so that the user knows whether to cancel the contract  

◆ ContractBoatBeam

ContractBoatBeam

 

 

◆ ContractBoatLength

ContractBoatLength

 

 

◆ ContractCanxDate

ContractCanxDate

The effective date of the cancellation.

 

◆ ContractChargeTotal

ContractChargeTotal

The sum of the Contract Charges due for this contract.

Exclusive of Vat  

◆ ContractChargeTotalInclVat

ContractChargeTotalInclVat

 

 

◆ ContractDescription

ContractDescription

 

 

◆ ContractEndDate

ContractEndDate

 

 

◆ ContractID

ContractID

 

 

◆ ContractMooring

ContractMooring

Initial mooring for contract.

Note: this may not be the current mooring

 

◆ ContractNotes

ContractNotes

 

 

◆ ContractNumber

ContractNumber

 

 

◆ ContractStartDate

ContractStartDate

 

 

◆ ContractStartDateInt

ContractStartDateInt

 

 

◆ ContractStatus

ContractStatus

The status of the contract.

Current Previous Future a non confirmed contract in the future (will not become active) Confirmed a confirmed contract in the future (will become active) Cancelled  

◆ ContractTab

ContractTab

Transient field for synchronising tabs in VB.

 

◆ ContractType

ContractType

' Temporary/Permanent/...

 

◆ CurrentBerth

CurrentBerth

The berth that the boat is currently in as of todays date.

 

◆ DepositAmount

DepositAmount

Calculated deposit.

If DepositValue field is populated then return this otherwis calculate deposit based on parameters in options  

◆ DepositAmountValue

DepositAmountValue

Calculated deposit.

If DepositValue field is populated then return this otherwis calculate deposit based on parameters in options  

◆ DepositValue

DepositValue

Deposit value if this is set by the user then it will override the.

calculated DepoistAmount field  

◆ EffectiveBoatLength

EffectiveBoatLength

 

 

◆ EffectiveBoatLengthValue

EffectiveBoatLengthValue

 

 

◆ FirstPrintedDate

FirstPrintedDate

 

 

◆ FixedBoatBeam

FixedBoatBeam

 

 

◆ FixedBoatLength

FixedBoatLength

 

 

◆ GenerationDate

GenerationDate

 

 

◆ Invoiced

Invoiced

Has an invoice been raised against this contract - includes.

invoices made using adhoc method and linked to contract  

◆ InvoicedAmount

InvoicedAmount

 

 

◆ LengthXTariff

LengthXTariff

 

 

◆ LengthXTariffValue

LengthXTariffValue

 

 

◆ LengthXTariffXPeriod

LengthXTariffXPeriod

 

 

◆ LengthXTariffXPeriodValue

LengthXTariffXPeriodValue

 

 

◆ Locked

Locked

 

 

◆ MaximumNumberOfPayments

MaximumNumberOfPayments

 

 

◆ Modified

Modified

Has the contract instance been changed.

1 yes 0 no  

◆ MooringChargeScheme

MooringChargeScheme

Which charging plan is this contract using.

ie Annual or Monthly or daily etc  

◆ MooringFee

MooringFee

 

 

◆ MooringFeeInclVat

MooringFeeInclVat

 

 

◆ MooringFeeInclVatValue

MooringFeeInclVatValue

 

 

◆ MooringFeeLessDeposit

MooringFeeLessDeposit

 

 

◆ MooringFeeValue

MooringFeeValue

 

 

◆ MooringFeeVatAmount

MooringFeeVatAmount

 

 

◆ MooringTab

MooringTab

Transient property used for synchronising tabs in vb.

 

◆ NewContract

NewContract

The contract that was generated based on this one.

 

◆ NumberOfPhasedPayments

NumberOfPhasedPayments

Used in the payment schedule.

 

◆ OldStatus

OldStatus

if the contract status is changed then update this field

then when saving the contract compare the status with this field

if the two values are different then Audit the new Status  

◆ PaymentMethod

How is the contract to be paid.

ie Cheque/Credit Card/Direct Debit...  

◆ PaymentScheme

PaymentScheme

Similar to Payment Type but refined to include 3-part and 8-part Phased.

 

◆ PaymentType

PaymentType

Deprecated.

Don't use this property. Use paymenttype instead

Advanced/Phased  

◆ PerformBalanceTransfer

PerformBalanceTransfer

has confirmed been set to true? If so then if we transfer

balances between contracts do it  

◆ PermanentMooring

PermanentMooring

Permanent Mooring - This boat may be moved.

This indicates the mooring to use for a renewal.

 

◆ PhasedContractValue

PhasedContractValue

Sum of the Scheduled Payments for this contract.

 

◆ PhasedStartMonthOffset

PhasedStartMonthOffset

The month that the first phased payment is due.

 

◆ PhasedStartYear

PhasedStartYear

The year in which the first phased payment is due.

 

◆ Previewed

Previewed

Has the contract document been printed or print previewed.

 

◆ PreviousContract

PreviousContract

The contract on which this contract is based.

 

◆ PrintDocument

PrintDocument

 

 

◆ Printed

Printed

Has the contract been printed.

 

◆ ReceiptsTotal

ReceiptsTotal

The total Receipts for a contract inclusive of VAT.

The calculated is derived in different ways, depending whether the site actually uses Receipts. If they do not it is the total Invoice - Associated Credit Notes e.g. for Dean & Reddyhoff.  

◆ Revision

Revision

 

 

◆ ServiceBalance

ServiceBalance

 

 

◆ SpecialRate

SpecialRate

Mooring Fee entered by user which overrides calculated Mooring Fee.

 

◆ TotalExclVat

TotalExclVat

 

 

◆ TotalExclVatFixed

TotalExclVatFixed

The total after the contract has been locked.

 

◆ TotalInclVat

TotalInclVat

 

 

◆ TotalInclVatFixed

TotalInclVatFixed

 

 

◆ TotalPaidInAdvance

TotalPaidInAdvance

 

 

◆ TotalVat

TotalVat

 

 

◆ UnitPriceDescription

UnitPriceDescription

 

 

◆ ValuesLocked

ValuesLocked

 

 

◆ WholeAmountPhased

WholeAmountPhased

 

 

◆ oldConfirmed

oldConfirmed

Database value of the confirmed field.

If we have changed he confirmed field in the open instance, use this to get the previous value