clsProviderTaxIDCollection¶

BOF collection type for provider tax ID records.

Purpose¶

Load and manage a BOF collection of related provider records.

Context¶

Namespace: SAIF.Business.Provider
Assembly/package: SAIF.Business.Provider

Public members¶

Member	Signature	Purpose
OriginalPrimaryTaxID	`ReadOnly Property OriginalPrimaryTaxID As Nullable(Of Decimal)`	Stores the original primary tax ID value.
Save	`Overrides Function Save As Boolean`	Applies pending edits and persists the current object graph through the BOF save pipeline.
Contains	`Overloads Function Contains(ByVal inProviderTaxID As String) As Boolean`	Checks whether the collection already contains an item matching the supplied key.
ContainsDeleted	`Overloads Function ContainsDeleted(ByVal inProviderTaxID As clsProviderTaxID) As Boolean`	Checks whether the collection already contains an item matching the supplied key.
ContainsDeleted	`Overloads Function ContainsDeleted(ByVal inProviderTaxID As String) As Boolean`	Checks whether the collection already contains an item matching the supplied key.
Remove	`Overloads Sub Remove(ByVal inProviderTaxID As clsProviderTaxID)`	Sends the targeted data through the owning provider workflow.
Remove	`Overloads Sub Remove(ByVal inProviderTaxID As String)`	Sends the targeted data through the owning provider workflow.
GetProviderTaxIDCollection	`Shared Function GetProviderTaxIDCollection(ByVal inDataportal As IDataPortalInfo, ByVal inProviderSeqNum As Decimal) As clsProviderTaxIDCollection`	Retrieves provider tax id collection through the BOF data portal.

Behavioral notes¶

This type wraps a BOF child collection and coordinates retrieval and save behavior for related records.

Constraints and usage notes¶

Load the collection through its retrieval methods so BOF criteria and child-object wiring remain consistent.

Inherited members (from clsBusinessCollectionBase via clsBusinessCollection(Of T))¶

This collection type inherits the following public surface from clsBusinessCollectionBase (Legacy\BusinessObjectFramework\clsBusinessCollectionBase.vb), in addition to the members listed above:

Member	Signature	Purpose
Item	`Default Public ReadOnly Property Item(ByVal index As Integer) As clsBusinessBase`	Returns the collection member at the given index (default indexer).
Add	`Sub Add(ByVal inChild As clsBusinessBase)`	Adds a child business object to the collection.
Remove	`Sub Remove(ByVal inChild As clsBusinessBase)`	Marks a child business object as deleted and removes it from the active list.
Contains	`Function Contains(ByVal Item As clsBusinessBase) As Boolean`	Indicates whether the collection contains the given item.
ContainsDeleted	`Function ContainsDeleted(ByVal Item As clsBusinessBase) As Boolean`	Indicates whether the given item exists in the collection's deleted-items list.
ItemByGuid	`ReadOnly Property ItemByGuid(ByVal inGuid As String) As clsBusinessBase`	Returns the collection member matching the given internal GUID.
MyGuid	`ReadOnly Property MyGuid() As String`	Returns the internal GUID that uniquely identifies this in-memory collection instance.
IsDirty	`ReadOnly Property IsDirty() As Boolean`	Indicates whether the collection or any child member has unsaved changes.
IsValid	`Overridable ReadOnly Property IsValid() As Boolean`	Indicates whether all child members currently have no broken validation rules.
ValidateAllChildren	`Overridable Property ValidateAllChildren() As Boolean`	Controls whether every child is validated or only the current item.
Rules	`ReadOnly Property Rules() As clsRulesManager`	Returns the rules manager that tracks broken rules for the collection.
ErrorCount / ErrorMessages	`ReadOnly Property ErrorCount() As Integer` / `ReadOnly Property ErrorMessages() As String()`	Returns the count and text of broken error-severity rules across the collection.
WarningCount / WarningMessages	`ReadOnly Property WarningCount() As Integer` / `ReadOnly Property WarningMessages() As String()`	Returns the count and text of broken warning-severity rules across the collection.
InformationalCount / InformationalMessages	`ReadOnly Property InformationalCount() As Integer` / `ReadOnly Property InformationalMessages() As String()`	Returns the count and text of broken informational-severity rules across the collection.
BeginEdit / CancelEdit / ApplyEdit	`Sub BeginEdit()` / `Sub CancelEdit()` / `Sub ApplyEdit()`	Begins, rolls back, or commits an edit transaction across the collection.
Save	`Overridable Function Save() As Boolean`	Persists all added, changed, and deleted members through the BOF data portal.
SaveChild	`Overridable Function SaveChild() As Boolean`	Persists the collection as a child of a parent object.
Clone	`Function Clone() As Object`	Returns a deep copy of the collection and its members.
IsManaged	`ReadOnly Property IsManaged() As Boolean`	Indicates whether the collection is managed by a parent object's lifecycle.
First / FirstItem	`Function First() As clsBusinessBase` / `ReadOnly Property FirstItem() As clsBusinessBase`	Moves to and/or returns the first item in traversal order.
Next / NextItem	`Function [Next]() As clsBusinessBase` / `ReadOnly Property NextItem() As clsBusinessBase`	Moves to and/or returns the next item in traversal order.
Previous / PreviousItem	`Function Previous() As clsBusinessBase` / `ReadOnly Property PreviousItem() As clsBusinessBase`	Moves to and/or returns the previous item in traversal order.
Last / LastItem	`Function Last() As clsBusinessBase` / `ReadOnly Property LastItem() As clsBusinessBase`	Moves to and/or returns the last item in traversal order.
CurrentItem / CurrentIndex	`ReadOnly Property CurrentItem() As clsBusinessBase` / `ReadOnly Property CurrentIndex() As Integer`	Returns the current traversal item and its index.
SetCurrent	`Sub SetCurrent(ByRef inObject As clsBusinessBase)` / `Sub SetCurrent(ByVal inIndex As Integer)`	Sets the current traversal position by item or index.
IndexOf	`ReadOnly Property IndexOf(ByVal inObject As clsBusinessBase) As Integer`	Returns the index of the given item within the collection.
IsFirst / IsNext / IsLast / IsPrevious / IsCurrent	`ReadOnly Property IsFirst(ByVal inItem As clsBusinessBase) As Boolean` (and analogous overloads)	Indicate an item's position relative to the current traversal state.
XMLElementName / XMLItemName	`Property XMLElementName() As String` / `Property XMLItemName() As String`	Get or set the XML element/item names used when serializing the collection.
GetReportXML	`Function GetReportXML(ByVal inElementName As String) As String` (and file-stream overload)	Returns an XML fragment representing the collection and its members.
ToXML / ToXml	`Function ToXML() As String` / `Function ToXml(ByVal inTagName As String) As String`	Serializes the collection to XML using the default or a supplied tag name.
## Sources
- `Business\SAIF.Business.Provider\clsProviderTaxIDCollection.vb`