clsProviderRelationship¶
Business object for provider-to-provider relationships.
Purpose¶
- Represent persisted provider-domain data within the BOF object model.
Context¶
- Namespace:
SAIF.Business.Provider - Assembly/package:
SAIF.Business.Provider
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| RelationshipExists | ReadOnly Property RelationshipExists As Boolean |
Exposes the relationship exists value on this type. |
| RelationshipInUse | ReadOnly Property RelationshipInUse As Boolean |
Exposes the relationship in use value on this type. |
| ProviderLocationSeqNum | Property ProviderLocationSeqNum As Decimal |
Stores the provider location sequence number value. |
| ParentProviderLocSeqNum | Property ParentProviderLocSeqNum As Decimal |
Stores the parent provider loc sequence number value. |
| ProviderRelationshipCode | Property ProviderRelationshipCode As String |
Stores the provider relationship code value. |
| ReverseDescription | ReadOnly Property ReverseDescription As Boolean |
Exposes the reverse description value on this type. |
| EffDate | Property EffDate As Date |
Stores the eff date value. |
| ExpDate | Property ExpDate As Date |
Stores the exp date value. |
| UpdateUser | ReadOnly Property UpdateUser As String |
Returns the update user value recorded on the object. |
| UpdateNum | ReadOnly Property UpdateNum As Decimal |
Returns the update num value recorded on the object. |
| UpdateDate | ReadOnly Property UpdateDate As Date |
Returns the update date value recorded on the object. |
| FullNameParent | ReadOnly Property FullNameParent As String |
Exposes the full name parent value on this type. |
| FullNameChild | ReadOnly Property FullNameChild As String |
Exposes the full name child value on this type. |
| OrigProviderLocationSeqNum | ReadOnly Property OrigProviderLocationSeqNum As Decimal |
Stores the orig provider location sequence number value. |
| OrigParentProviderLocSeqNum | ReadOnly Property OrigParentProviderLocSeqNum As Decimal |
Stores the orig parent provider loc sequence number value. |
| OrigEffDate | ReadOnly Property OrigEffDate As Date |
Stores the orig eff date value. |
| ProviderRelationship | ReadOnly Property ProviderRelationship As String |
Exposes the provider relationship value on this type. |
| Location | ReadOnly Property Location As clsProviderLocation |
Exposes the location value on this type. |
| ProviderRelationshipDto | ReadOnly Property ProviderRelationshipDto As ProviderRelationshipDto |
Exposes the provider relationship DTO value on this type. |
| NewProviderRelationship | Shared Function NewProviderRelationship(ByVal inDataportal As IDataPortalInfo, ByVal inProviderLocationSeqNum As Decimal) As clsProviderRelationship |
Creates a new provider relationship instance through the BOF data portal. |
| GetProviderRelationship | Shared Function GetProviderRelationship(ByVal inDataportal As IDataPortalInfo, ByVal inProviderLocationSeqNum As Decimal, ByVal inParentProviderLocSeqNum As Decimal, ByVal inEffDate As Date) As clsProviderRelationship |
Retrieves provider relationship through the BOF data portal. |
Behavioral notes¶
- This type participates in the provider-domain BOF object model and data-portal lifecycle.
Constraints and usage notes¶
- Use the BOF factory, retrieval, and save patterns associated with this library when changing persisted state.
Inherited members (from clsBusinessBase)¶
This type inherits the following public surface from clsBusinessBase (Legacy\BusinessObjectFramework\clsBusinessBase.vb), in addition to the members listed above:
| Member | Signature | Purpose |
|---|---|---|
| MyGuid | ReadOnly Property MyGuid() As String |
Returns the internal GUID that uniquely identifies this in-memory object instance. |
| IsNew | ReadOnly Property IsNew() As Boolean |
Indicates whether the object has not yet been persisted. |
| IsDeleted | ReadOnly Property IsDeleted() As Boolean |
Indicates whether the object is marked for deletion. |
| IsDirty | Overridable ReadOnly Property IsDirty() As Boolean |
Indicates whether the object (or a child) has unsaved changes. |
| IsValid | Overridable ReadOnly Property IsValid() As Boolean |
Indicates whether the object currently has no broken validation rules. |
| ValidateOnDelete | Property ValidateOnDelete As Boolean |
Controls whether validation rules run before a delete operation. |
| Rules | ReadOnly Property Rules() As clsRulesManager |
Returns the rules manager that tracks broken rules for this object. |
| ErrorCount | ReadOnly Property ErrorCount() As Integer |
Returns the number of broken error-severity rules. |
| ErrorMessages | ReadOnly Property ErrorMessages() As String() |
Returns the text of all broken error-severity rules. |
| WarningCount | ReadOnly Property WarningCount() As Integer |
Returns the number of broken warning-severity rules. |
| WarningMessages | ReadOnly Property WarningMessages() As String() |
Returns the text of all broken warning-severity rules. |
| InformationalCount | ReadOnly Property InformationalCount() As Integer |
Returns the number of broken informational-severity rules. |
| InformationalMessages | ReadOnly Property InformationalMessages() As String() |
Returns the text of all broken informational-severity rules. |
| BeginEdit | Sub BeginEdit() |
Begins an editable transaction, snapshotting current field values. |
| CancelEdit | Sub CancelEdit() |
Rolls back field values to the last BeginEdit snapshot. |
| ApplyEdit | Sub ApplyEdit() |
Commits the current edit transaction, discarding the rollback snapshot. |
| Delete | Sub Delete() |
Marks the object for deletion on the next save. |
| Save | Overridable Function Save() As Boolean |
Persists the object (insert, update, or delete) through the BOF data portal, if valid. |
| SaveChild | Overridable Function SaveChild() As Boolean |
Persists the object as a child of a parent object/collection. |
| Clone | Function Clone() As Object |
Returns a deep copy of the object. |
| XMLElementName | Property XMLElementName() As String |
Gets or sets the XML element name used when serializing this object. |
| GetDataset | Sub GetDataset(ByRef inDS As DataSet) |
Populates a DataSet with the object's field values. |
| GetDataset (named table) | Sub GetDataset(ByRef inDS As DataSet, ByVal inTableName As String) |
Populates a DataSet table with the given name with the object's field values. |
| GetReportXML | Function GetReportXML(ByVal inElementName As String) As String |
Returns an XML fragment representing the object using the supplied element name. |
| GetReportXML (default name) | Function GetReportXML() As String |
Returns an XML fragment representing the object using the default XML element name. |
| ToXml | Function ToXml() As String |
Serializes the object to XML using the default element name. |
| ToXml (named tag) | Function ToXml(ByVal inTagName As String) As String |
Serializes the object to XML using the supplied tag name. |
| PreviousLinkItem / NextLinkItem | ReadOnly Property PreviousLinkItem() As ILinkItem / ReadOnly Property NextLinkItem() As ILinkItem |
Returns the adjacent linked-list item for collection traversal. |
| SetValueOnChange | Function SetValueOnChange(Of T)(ByRef inFieldValue As T, ByVal inSetValue As T, Optional ByVal inMarkDirty As Boolean = True) As Boolean |
Sets a backing field only when the value changes, optionally marking the object dirty. |
| ## Sources | ||
- Business\SAIF.Business.Provider\clsProviderRelationship.vb |