---
title: clsAwardSSOffsetCollection
summary: API reference for clsAwardSSOffsetCollection.
status: draft
owner: SAIF Doc Gen
last_reviewed: 2026-07-28
library: SAIF.Business.Claim.Payment
reference_type: package
---

# clsAwardSSOffsetCollection

`clsAwardSSOffsetCollection` represents a collection of award social security offsets used in state award processing, with lookup and list-management operations.*

## Purpose
- Holds award social security offsets used by the surrounding workflow.*
- Supports indexed lookup and membership checks for the contained items.*
- Provides factory or retrieval entry points for building the collection.*

## Context
- Namespace: `StateAwards`
- Assembly/package: `SAIF.Business.Claim.Payment`

## Public members
| Member | Signature | Purpose |
| --- | --- | --- |
| `Item` | `Default Public ReadOnly Property Item(ByVal Index As Integer) As clsAwardSSOffset` | Returns item. |
| `Item` | `Default Public ReadOnly Property Item(ByVal inAwardSSOffsetID As String) As clsAwardSSOffset` | Returns item. |
| `CurrentItem` | `Public Shadows ReadOnly Property CurrentItem() As clsAwardSSOffset` | Returns current item. |
| `Save` | `Public Overrides Function Save() As Boolean` | Executes the `Save` operation. |
| `NewSocialSecurityOffset` | `Public Function NewSocialSecurityOffset(ByVal inPersonID As Decimal) As clsAwardSSOffset` | Executes the `NewSocialSecurityOffset` operation. |
| `Contains` | `Public Overloads Function Contains(ByVal inclsAwardSSOffset As clsAwardSSOffset) As Boolean` | Exposes the public member. |
| `Contains` | `Public Overloads Function Contains(ByVal inAwardSSOffsetID As Decimal) As Boolean` | Exposes the public member. |
| `ContainsDeleted` | `Public Overloads Function ContainsDeleted(ByVal inclsAwardSSOffset As clsAwardSSOffset) As Boolean` | Exposes the public member. |
| `ContainsDeleted` | `Public Overloads Function ContainsDeleted(ByVal inAwardSSOffsetID As Decimal) As Boolean` | Exposes the public member. |
| `Remove` | `Public Sub Remove(ByVal inclsAwardSSOffset As clsAwardSSOffset)` | Executes the `Remove` operation. |
| `Remove` | `Public Sub Remove(ByVal inAwardSSOffsetID As Decimal)` | Executes the `Remove` operation. |
| `Where` | `Public Function Where(ByVal match As Predicate(Of clsAwardSSOffset)) As clsAwardSSOffsetCollection` | Exposes the public member. |
| `ToDateRangeList` | `Public Function ToDateRangeList() As System.Collections.Generic.IEnumerable(Of Framework.IDateRange) Implements Framework.IDateRangeList.ToDateRangeList` | Exposes the public member. |
| `GetAwardSSOffsets` | `Public Shared Function GetAwardSSOffsets(ByVal inDataportal As IDataPortalInfo, ByVal inAwardNumber As Decimal, ByVal inClaimData As clsClaimData) As clsAwardSSOffsetCollection` | Retrieves the `GetAwardSSOffsets` operation. |

## Inherited public members

| Member | Signature | Purpose | Origin |
| --- | --- | --- | --- |
| `MyGuid` | `Public ReadOnly Property MyGuid() As String` | Returns the collection's generated GUID identifier.† | `Legacy\BusinessObjectFramework` — `clsBusinessCollectionBase` |
| `Add` | `Public Sub Add(ByVal inChild As clsBusinessBase)` | Adds a BOF child object through the untyped base collection API.† | `Legacy\BusinessObjectFramework` — `clsBusinessCollectionBase` |
| `First` | `Public Function First() As clsBusinessBase` | Sets traversal to and returns the first child object.† | `Legacy\BusinessObjectFramework` — `clsBusinessCollectionBase` |
| `Next` | `Public Function [Next]() As clsBusinessBase` | Advances traversal to and returns the next child object.† | `Legacy\BusinessObjectFramework` — `clsBusinessCollectionBase` |

## Behavioral notes
- This type is documented from its source declaration.
- The type participates in the `clsBusinessCollectionBase` 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\clsAwardSSOffsetCollection.vb`
- `Legacy\BusinessObjectFramework\clsBusinessCollectionBase.vb`