clsAward¶

clsAward represents an abstract state award and exposes status values, award type map, and award status map for state award processing.*

Purpose¶

Captures status values, award type map, and award status map for state award processing.*
Participates in the award payment workflow through validation, approval, or save steps.*

Context¶

Namespace: StateAwards
Assembly/package: SAIF.Business.Claim.Payment

Public members¶

Member	Signature	Purpose
`AwardTypeMap`	`Public ReadOnly Property AwardTypeMap() As clsAwardTypeMap`	Returns award type map.
`GetAwardTypeMap`	`Public Shared Function GetAwardTypeMap(Optional ByVal RefreshAwardTypes As Boolean = False) _`	Retrieves the `GetAwardTypeMap` operation.
`AwardStatusMap`	`Public ReadOnly Property AwardStatusMap() As clsAwardStatusMap`	Returns award status map.
`GetAwardStatusMap`	`Public Shared Function GetAwardStatusMap(ByVal inDPI As IDataPortalInfo, Optional ByVal RefreshAwardTypes As Boolean = False) _`	Retrieves the `GetAwardStatusMap` operation.
`FinancialTransactionMode`	`Public Property FinancialTransactionMode() As AwardMode`	Gets or sets financial transaction mode.
`AwardType`	`Public MustOverride ReadOnly Property AwardType() As AwardTypes Implements IAward.AwardType`	Returns award type.
`AwardPayments`	`Public MustOverride ReadOnly Property AwardPayments() As IEnumerable(Of IAwardPayment) Implements IAward.AwardPayments`	Returns award payments.
`AwardApprovalErrors`	`Public ReadOnly Property AwardApprovalErrors() As clsPaymentBase.ApprovalErrors()`	Returns award approval errors.
`Approve`	`Public MustOverride Function Approve() As clsPaymentBase.ApprovalErrors`	Exposes the public member.
`Disapprove`	`Public Overridable Sub Disapprove()`	Exposes the public member.
`GetAwardType`	`Public Shared Function GetAwardType(ByVal inDPI As IDataPortalInfo, ByVal inAwardNumber As Decimal) As AwardTypes`	Retrieves the `GetAwardType` operation.
`GetSpecificAward`	`Public Shared Function GetSpecificAward(ByVal inDPI As IDataPortalInfo, ByVal inAwardNumber As Decimal) As IAward`	Retrieves the `GetSpecificAward` operation.
`GetAwardCount`	`Public Shared Function GetAwardCount(ByVal inDPI As IDataPortalInfo, ByVal inClaimID As Decimal, Optional ByVal inStatus As AwardStatus = AwardStatus.Active) As Decimal`	Retrieves the `GetAwardCount` operation.
`GetPayment`	`Public Function GetPayment(ByVal inPaymentID As Decimal) As IAwardPayment Implements IAward.GetPayment`	Retrieves the `GetPayment` operation.
`IsApproved`	`Public ReadOnly Property IsApproved() As Boolean`	Returns is approved.
`IsInProgress`	`Public ReadOnly Property IsInProgress() As Boolean`	Returns is in progress.
`IsAwaitingApproval`	`Public ReadOnly Property IsAwaitingApproval() As Boolean`	Returns is awaiting approval.
`InitiatorUser`	`Public Property InitiatorUser() As String`	Gets or sets initiator user.
`ApproverUser`	`Public Property ApproverUser() As String`	Gets or sets approver user.
`PercentLimitChangeDate`	`Public ReadOnly Property PercentLimitChangeDate() As Date`	Returns percent limit change date.
`AwardNumber`	`Public ReadOnly Property AwardNumber() As Decimal Implements IAward.AwardNumber`	Returns award number.
`ClaimID`	`Public ReadOnly Property ClaimID() As Decimal Implements IAward.ClaimID`	Returns claim i d.
`Status`	`Public Property Status() As AwardStatus Implements IAward.Status`	Gets or sets status.
`OrderID`	`Public ReadOnly Property OrderID() As Decimal Implements IAward.OrderID`	Returns order i d.
`ClosureID`	`Public ReadOnly Property ClosureID() As Decimal Implements IAward.ClosureID`	Returns closure i d.
`EffectiveDate`	`Public Property EffectiveDate() As Date Implements IAward.EffectiveDate`	Gets or sets effective date.
`NextIssueDate`	`Public Property NextIssueDate() As Date`	Gets or sets next issue date.
`IsAutoRecalc`	`Public Property IsAutoRecalc() As Boolean Implements IAward.IsAutoRecalc`	Gets or sets is auto recalc.
`TotalPayeeBalance`	`Public ReadOnly Property TotalPayeeBalance() As Decimal`	Returns total payee balance.
`TotalPaymentAmount`	`Public ReadOnly Property TotalPaymentAmount() As Decimal`	Returns total payment amount.
`TotalPaymentAmountExcludingRecovery`	`Public ReadOnly Property TotalPaymentAmountExcludingRecovery() As Decimal`	Returns total payment amount excluding recovery.
`TotalImmediatePaymentAmount`	`Public ReadOnly Property TotalImmediatePaymentAmount() As Decimal`	Returns total immediate payment amount.
`TotalImmediatePaymentAmountExcludingRecovery`	`Public ReadOnly Property TotalImmediatePaymentAmountExcludingRecovery() As Decimal`	Returns total immediate payment amount excluding recovery.
`TotalMonthlyPaymentAmount`	`Public ReadOnly Property TotalMonthlyPaymentAmount() As Decimal`	Returns total monthly payment amount.
`TotalMonthlyPaymentAmountExcludingRecovery`	`Public ReadOnly Property TotalMonthlyPaymentAmountExcludingRecovery() As Decimal`	Returns total monthly payment amount excluding recovery.
`TotalMonthlyReductionAmount`	`Public ReadOnly Property TotalMonthlyReductionAmount() As Decimal`	Returns total monthly reduction amount.
`TotalImmediateReductionAmount`	`Public ReadOnly Property TotalImmediateReductionAmount() As Decimal`	Returns total immediate reduction amount.
`TotalMonthlySupportAmount`	`Public ReadOnly Property TotalMonthlySupportAmount() As Decimal`	Returns total monthly support amount.
`TotaltImmediateSupportAmount`	`Public ReadOnly Property TotaltImmediateSupportAmount() As Decimal`	Returns totalt immediate support amount.
`TotalImmediateRetroReserveAmount`	`Public ReadOnly Property TotalImmediateRetroReserveAmount() As Decimal`	Returns total immediate retro reserve amount.
`TotalMonthlyRetroReserveAmount`	`Public ReadOnly Property TotalMonthlyRetroReserveAmount() As Decimal`	Returns total monthly retro reserve amount.
`Claim`	`Public ReadOnly Property Claim() As clsClaimData Implements IAward.Claim`	Returns claim.
`CurrentUser`	`Public ReadOnly Property CurrentUser() As clsPaymentUser`	Returns current user.
`IsExistingAward`	`Public Property IsExistingAward() As Boolean`	Gets or sets is existing award.
`UpdateNumber`	`Public ReadOnly Property UpdateNumber() As Decimal`	Returns update number.
`UpdateDate`	`Public ReadOnly Property UpdateDate() As Date`	Returns update date.
`UpdateUser`	`Public ReadOnly Property UpdateUser() As String`	Returns update user.
`UpdateInfo`	`Public ReadOnly Property UpdateInfo() As clsUpdateInfo`	Returns update info.
`GetMonthlyNextIssueDate`	`Public Function GetMonthlyNextIssueDate() As Date`	Retrieves the `GetMonthlyNextIssueDate` operation.
`GetDailyNextIssueDate`	`Public Function GetDailyNextIssueDate() As Date`	Retrieves the `GetDailyNextIssueDate` operation.
`HasPaymentsInProgress`	`Public ReadOnly Property HasPaymentsInProgress() As Boolean`	Returns has payments in progress.
`HasPayments`	`Public ReadOnly Property HasPayments() As Boolean`	Returns has payments.
`PaymentReleased`	`Public ReadOnly Property PaymentReleased() As Boolean`	Returns payment released.
`GenerateFinancialTransactions`	`Public Function GenerateFinancialTransactions(ByVal inIssueDate As Date) As Boolean Implements IAward.GenerateFinancialTransactions`	Exposes the public member.
`IsValid`	`Public Overrides ReadOnly Property IsValid() As Boolean`	Returns is valid.
`IsDirty`	`Public Overrides ReadOnly Property IsDirty() As Boolean`	Returns is dirty.
`Save`	`Public Shadows Function Save() As Boolean Implements IAward.Save`	Executes the `Save` operation.
`SetClosureOrderNull`	`Public Sub SetClosureOrderNull()`	Executes the `SetClosureOrderNull` operation.
`SetClosureOrder`	`Public Sub SetClosureOrder(ByVal inClosureID As Decimal, ByVal inOrderID As Decimal)`	Executes the `SetClosureOrder` operation.
`IsClosureOrderAssociated`	`Public Function IsClosureOrderAssociated() As Boolean`	Exposes the public member.
`SetAwardEffectiveDateNull`	`Public Sub SetAwardEffectiveDateNull()`	Executes the `SetAwardEffectiveDateNull` operation.
`SetNextIssueDateNull`	`Public Sub SetNextIssueDateNull()`	Executes the `SetNextIssueDateNull` operation.
`IsAwardEffectiveDateNull`	`Public Function IsAwardEffectiveDateNull() As Boolean`	Exposes the public member.
`IsNextIssueDateNull`	`Public Function IsNextIssueDateNull() As Boolean`	Exposes the public member.
`Equals`	`Public Overloads Shared Function Equals(ByVal objA As Object, ByVal objB As Object) As Boolean`	Exposes the public member.
`Equals`	`Public Overloads Overrides Function Equals(ByVal inObject As Object) As Boolean`	Exposes the public member.
`Equals`	`Public Overloads Function Equals(ByVal inObject As clsAward) As Boolean`	Exposes the public member.
`GetHashCode`	`Public Overrides Function GetHashCode() As Integer`	Retrieves the `GetHashCode` operation.
`ToString`	`Public Overrides Function ToString() As String`	Exposes the public member.

Inherited public members¶

Member	Signature	Purpose	Origin
`MyGuid`	`Public ReadOnly Property MyGuid() As String`	Returns the object's generated GUID identifier.†	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`IsNew`	`Public ReadOnly Property IsNew() As Boolean`	Indicates whether the object represents unsaved data.†	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`IsDeleted`	`Public ReadOnly Property IsDeleted() As Boolean`	Indicates whether the object has been marked for deletion.†	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`SetValueOnChange`	`Public Function SetValueOnChange(Of T)(ByRef inFieldValue As T, ByVal inSetValue As T, Optional ByVal inMarkDirty As Boolean = True) As Boolean`	Assigns a new field value only when it differs and optionally marks the object dirty.†	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`Rules`	`Public ReadOnly Property Rules() As clsRulesManager`	Exposes the BOF rules manager for validation and messages.†	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`SaveChild`	`Public Overridable Function SaveChild() As Boolean`	Persists the object as a BOF child object.†	`Legacy\BusinessObjectFramework` — `clsBusinessBase`
`ToXml`	`Public Function ToXml() As String`	Returns the object's XML representation using the configured default tag name.†	`Legacy\BusinessObjectFramework` — `clsBusinessBase`

Behavioral notes¶

This type is documented from its source declaration.
The type participates in the clsBusinessBase inheritance path used by SAIF.Business.Claim.Payment.

Constraints and usage notes¶

Consumers should rely on the public members and BOF lifecycle patterns visible in the source file.

Note: Statements marked with † are derived from dependency library documentation via the Legends CLI.

Sources¶

Business\SAIF.Business.Claim.Payment\Payments\StateAwardPayments\clsAward.vb
Legacy\BusinessObjectFramework\clsBusinessBase.vb