clsAwardSSOffset¶

clsAwardSSOffset represents a social security offset for an award and exposes status values, social security status map, and update date for state award processing.*

Purpose¶

Captures status values, social security status map, and update date for state award processing.*

Context¶

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

Public members¶

Member	Signature	Purpose
`SocialSecurityStatusMap`	`Public ReadOnly Property SocialSecurityStatusMap() As clsSocialSecurityStatusMap`	Returns social security status map.
`GetSocialSecurityStatusMap`	`Public Shared Function GetSocialSecurityStatusMap(Optional ByVal inDPI As IDataPortalInfo = Nothing, Optional ByVal RefreshAwardTypes As Boolean = False) _`	Retrieves the `GetSocialSecurityStatusMap` operation.
`UpdateDate`	`Public ReadOnly Property UpdateDate() As Date`	Returns update date.
`UpdateUser`	`Public ReadOnly Property UpdateUser() As String`	Returns update user.
`AwardSSOffsetID`	`Public ReadOnly Property AwardSSOffsetID() As Decimal`	Returns award s s offset i d.
`AwardNumber`	`Public ReadOnly Property AwardNumber() As Decimal`	Returns award number.
`WorkerID`	`Public ReadOnly Property WorkerID() As Decimal`	Returns worker i d.
`EffectiveDate`	`Public Property EffectiveDate() As Date Implements IDateRange.BeginDate`	Gets or sets effective date.
`Status`	`Public Property Status() As SocialSecurityStatus`	Gets or sets status.
`MonthlyAmount`	`Public Property MonthlyAmount() As Decimal`	Gets or sets monthly amount.
`UpdateNumber`	`Public ReadOnly Property UpdateNumber() As Decimal`	Returns update number.
`ExpirationDate`	`Public Property ExpirationDate() As Date Implements IDateRange.EndDate`	Gets or sets expiration date.
`SocialSecurityOrderDate`	`Public Property SocialSecurityOrderDate() As Date`	Gets or sets social security order date.
`StatusDescription`	`Public ReadOnly Property StatusDescription() As String`	Returns status description.
`SetExpirationDateNull`	`Public Sub SetExpirationDateNull()`	Executes the `SetExpirationDateNull` operation.
`SetSocialSecurityOrderDateNull`	`Public Sub SetSocialSecurityOrderDateNull()`	Executes the `SetSocialSecurityOrderDateNull` operation.
`IsExpirationDateNull`	`Public Function IsExpirationDateNull() As Boolean Implements IDateRange.IsEndDateNull`	Exposes the public member.
`IsEffectiveDateNull`	`Public Function IsEffectiveDateNull() As Boolean Implements IDateRange.IsBeginDateNull`	Exposes the public member.
`IsSocialSecurityOrderDateNull`	`Public Function IsSocialSecurityOrderDateNull() 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 clsAwardSSOffset) 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.
`NewAwardSSOffset`	`Public Shared Function NewAwardSSOffset(ByVal inDataportal As IDataPortalInfo, ByVal inAwardNumber As Decimal, ByVal inWorkerID As Decimal, ByVal inClaimData As clsClaimData) As clsAwardSSOffset`	Executes the `NewAwardSSOffset` operation.
`AwardNumber`	`Public Property AwardNumber() As Decimal`	Gets or sets award number.
`WorkerID`	`Public Property WorkerID() As Decimal`	Gets or sets worker i d.
`New`	`Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo)`	Executes the `New` operation.
`New`	`Public Sub New(ByVal inDataPortalInfo As IDataPortalInfo, ByVal inAwardNumber As Decimal, ByVal inWorkerID As Decimal, ByVal inClaimData As clsClaimData)`	Executes the `New` operation.

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`
`Save`	`Public Overridable Function Save() As Boolean`	Persists the object through the BOF save pipeline.†	`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\clsAwardSSOffset.vb
Legacy\BusinessObjectFramework\clsBusinessBase.vb