clsClaimLegalRepresentativeCollection¶
clsClaimLegalRepresentativeCollection holds the legal representative records associated with a claim and supports lookup of effective-dated entries.
Purpose¶
- Organize the legal representative history recorded for a claim.
- Support collection-level retrieval and item lookup for effective-dated legal representative entries.
Context¶
- Namespace:
SAIF.Business.Claim.Maintenance - Assembly/package:
SAIF.Business.Claim.Maintenance
Public members¶
| Member | Signature | Purpose |
|---|---|---|
Item |
Default Public ReadOnly Property Item(ByVal Index As Integer) As clsClaimLegalRepresentative |
Returns item. |
Item |
Default Public ReadOnly Property Item(ByVal inClaimID As String) As clsClaimLegalRepresentative |
Returns item. |
Item |
Default Public ReadOnly Property Item(ByVal inEffDt As Date) As clsClaimLegalRepresentative |
Returns item. |
MyCriteria |
Public ReadOnly Property MyCriteria() As Criteria |
Returns my criteria. |
Save |
Public Overrides Function Save() As Boolean |
Executes the Save operation. |
NewClaimLegalRepresentativeCollection |
Public Shared Function NewClaimLegalRepresentativeCollection(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal) As clsClaimLegalRepresentativeCollection |
Executes the NewClaimLegalRepresentativeCollection operation. |
GetClaimLegalRepresentativeCollection |
Public Shared Function GetClaimLegalRepresentativeCollection(ByVal inDataportal As IDataPortalInfo, ByVal inClaimID As Decimal) As clsClaimLegalRepresentativeCollection |
Retrieves the GetClaimLegalRepresentativeCollection operation. |
Behavioral notes¶
- This type is documented from its source declaration.
- The type participates in the
clsBusinessCollectionApiBaseinheritance path used bySAIF.Business.Claim.Maintenance.
Constraints and usage notes¶
- Consumers should rely on the public members and BOF lifecycle patterns visible in the source file.
Inherited members (from clsBusinessCollectionApiBase)¶
This collection type inherits the following public surface from clsBusinessCollectionApiBase (SAIF.Framework.Core), in addition to the members listed above:
| Member | Signature | Purpose |
|---|---|---|
MyGuid |
Public ReadOnly Property MyGuid() As String |
Returns the internal GUID that uniquely identifies this in-memory collection instance. |
ItemByGuid |
Public ReadOnly Property ItemByGuid(inGuid As String) As clsBusinessApiBase |
Returns the collection member matching the given internal GUID. |
Contains |
Public Function Contains(Item As clsBusinessApiBase) As Boolean |
Indicates whether the collection contains the given item. |
ContainsDeleted |
Public Function ContainsDeleted(Item As clsBusinessApiBase) As Boolean |
Indicates whether the given item exists in the collection's deleted-items list. |
Rules |
Public ReadOnly Property Rules() As clsRulesManager |
Returns the rules manager that tracks broken rules for the collection. |
ErrorCount / ErrorMessages |
Public ReadOnly Property ErrorCount() As Integer / Public ReadOnly Property ErrorMessages() As String() |
Returns the count and text of broken error-severity rules across the collection. |
WarningCount / WarningMessages |
Public ReadOnly Property WarningCount() As Integer / Public ReadOnly Property WarningMessages() As String() |
Returns the count and text of broken warning-severity rules across the collection. |
InformationalCount / InformationalMessages |
Public ReadOnly Property InformationalCount() As Integer / Public ReadOnly Property InformationalMessages() As String() |
Returns the count and text of broken informational-severity rules across the collection. |
Save |
Overridable Function Save() As Boolean |
Persists the collection to the API, including added, changed, and deleted members, when the collection is valid. |
SaveChild |
Overridable Function SaveChild() As Boolean |
Persists the collection as a child of a parent object. |
IsManaged |
Public ReadOnly Property IsManaged() As Boolean |
Indicates whether the collection is managed by a parent object's lifecycle. |
First / FirstItem |
Function First() As clsBusinessApiBase / ReadOnly Property FirstItem() As clsBusinessApiBase |
Moves to and/or returns the first item in traversal order. |
Next / NextItem |
Function [Next]() As clsBusinessApiBase / ReadOnly Property NextItem() As clsBusinessApiBase |
Moves to and/or returns the next item in traversal order. |
Previous / PreviousItem |
Function Previous() As clsBusinessApiBase / ReadOnly Property PreviousItem() As clsBusinessApiBase |
Moves to and/or returns the previous item in traversal order. |
Last / LastItem |
Function Last() As clsBusinessApiBase / ReadOnly Property LastItem() As clsBusinessApiBase |
Moves to and/or returns the last item in traversal order. |
CurrentItem / CurrentIndex |
ReadOnly Property CurrentItem() As clsBusinessApiBase / ReadOnly Property CurrentIndex() As Integer |
Returns the current traversal item and its index. |
SetCurrent |
Sub SetCurrent(ByRef inObject As clsBusinessApiBase) / Sub SetCurrent(ByVal inIndex As Integer) |
Sets the current traversal position by item or index. |
IndexOf |
ReadOnly Property IndexOf(ByVal inObject As clsBusinessApiBase) As Integer |
Returns the index of the given item within the collection. |
IsFirst / IsNext / IsLast / IsPrevious / IsCurrent |
ReadOnly Property IsFirst(ByVal inItem As clsBusinessApiBase) 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 and item names used when serializing the collection. |
GetReportXML |
Function GetReportXML(ByVal inElementName As String) As String / Function GetReportXML(Optional ByVal inFileStream As StreamWriter = Nothing) As String |
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 using the default or a supplied tag name. |
CurrentItem (generic) |
Public Shadows ReadOnly Property CurrentItem() As ItemType |
Returns the current item with the collection's concrete generic type. |
Contains (generic) |
Public Overloads Function Contains(Item As ItemType) As Boolean / Public Overloads Function Contains(Guid As String) As Boolean |
Checks for a member by typed instance or internal GUID. |
GetEnumerator |
Public Overloads Function GetEnumerator() As IEnumerator(Of ItemType) |
Iterates over the collection using the concrete item type. |
Sources¶
Business\SAIF.Business.Claim.Maintenance\clsClaimLegalRepresentativeCollection.vb